OZO FHIR implementation guide
0.1.0 - ci-build
OZO FHIR implementation guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
The OZO platform connects care professionals with informal caregivers. The platform is able to create a link between the formal healthcare network with the informal social environment of the patient. Hereby the OZO platform needs to cross borders of healthcare and open up to the social context of the patents.
TODO: give a functional overview.
For a complete list of all FHIR profiles, examples, and resources defined in this Implementation Guide, see the Artifacts page. The Artifacts page includes links to the FSH source files for all resources.
Please refer to the following documentation of the Dutch name element:
The FHIR API is based on FHIR R4 and makes use of the following FHIR resources:
Profile: OZOPatient
The Patient represents the client in the domain, for each real-life patient only one single entity exists. The
Patient
is primary identified by the BSN. Required fields:
| field | cardinality | description |
|---|---|---|
| identifier[system="OZO/Person"] | 1..1 | |
| name | 1..* | The name field, ZIB |
| gender | 1..1 | |
| birthDate | 1..1 | |
| active | 1..1 | true |
The identifier of the Patient must be unique and should the internal identifier of the patient in the OZO system.
Profile: OZORelatedPerson
The related person resource represents the relation between Patient and a informal caregiver (RelatedPerson). For
each relationship
between a patient and informal caregiver one related person exists. For each real-life person multiple related person
resources exist, one for each patient it has a caregiving relationship with.
| field | cardinality | description |
|---|---|---|
| identifier[system="OZO/NetworkRelation"] identifier[system="OZO/Person"] | 1..* | The OZO assigned account id |
| name | 1..* | The name field, ZIB |
| patient | 1..1 | The reference to the patient |
| relationship | 1..1 | system=urn:oid:2.16.840.1.113883.5.111 |
| active | 1..1 | true |
The relationship coding can be found here:
The OZO FHIR RelatedPerson uses two identities to identify the RelatedPerson entity:
Profile: OZOPractitioner
The Practitioner represents a health care professional that has a relationship with one or more patients. The
practitioner is linked to the patient by the care team.
| field | cardinality | description |
|---|---|---|
| identifier[system=UZI|BIG] | 1..1 | |
| name | 1..1 | The name field, ZIB |
| active | 1..1 | true |
The identifier of the Practitioner must be unique and should the internal identifier of the patient in the OZO
system.
Profile: OZOCareTeam
The CareTeam is the resource that binds the patient to the related person(s) and practitioners. There should exist
only one care team resource for each patient in the system. Multiple care team resources could exist if specific use
cases require this. A CareTeam has a set of participants that consists of a member. For practitioners, this
relationship should also contain the onBehalfOf property, linking to the Organization, this maps the relation of
the Patient to different Organizations
| field | Cardinality | description |
|---|---|---|
| subject | 1..1 | reference to the Patient |
| participant | 1..* | a reference to a Patient, RelatedPerson, Practitioner or CareTeam |
| status | 1..1 | "active" |
Profile: OZOOrganization
The Organization resource represents the different organizations in the network. The relation between the Patient and
Organization is managed by the participant in the care team. Each member of type Practitioner has an onBehalfOf
reference to the Organization.
| field | Cardinality | description |
|---|---|---|
| identifier[system=ura] | 1..1 | |
| name | 1..1 | The name of the Organization |
The identifier of the Organization must be unique and should the internal identifier of the patient in the OZO
system.
The different interactions are described in the following guides:
Messaging can be used within the OZO FHIR API. To achieve this, the following 2 FHIR Resources are used:
Profile: OZOCommunicationRequest
The CommunicationRequest Resource is used to:
| field | Cardinality | description |
|---|---|---|
| status | 1..1 | draft | active | completed |
| subject | 1..1 | Reference to a Patient |
| requester | 1..1 | a reference to a RelatedPerson or Practitioner |
| recipient | 1..* | a reference to a RelatedPerson, Practitioner or CareTeam |
| payload | 1..* | Message or attachment, one of contentString or contentAttachment |
Profile: OZOCommunication
The Communication resource is used to:
| field | Cardinality | description |
|---|---|---|
| status | 1..1 | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
| partOf | 1..1 | Reference to a CommunicationRequest |
| sender | 1..1 | a reference to a RelatedPerson or Practitioner |
| recipient | 1..* | a reference to a RelatedPerson, Practitioner or CareTeam |
| payload | 1..* | Message or attachment, one of contentString or contentAttachment |
The Attachment resource is used to:
CommunicationRequest and Communication resource.Profile: OZOTask
The Task resource is used to:
| field | Cardinality | description |
|---|---|---|
| status | 1..1 | requested |
| basedOn | 1..1 | Reference to a CommunicationRequest |
| intent | 1..1 | order |
| for | 1..1 | a reference to a Patient |
| owner | 1..1 | a reference to a RelatedPerson or Practitioner |
Profile: OZOAuditEvent (custom profile for NEN7510 compliance)
The AuditEvent is used to:
Task status field as client of the OZO FHIR ApiFor detailed information about NEN7510 compliance and audit logging, see AuditEvent for NEN7510 Compliance.
Profile: Subscription (based on FHIR R4 Subscription resource)
The Subscription resource is used for clients of the OZO FHIR Api to receive updates about events in the changes in the FHIR Api:
The different interactions are described in the following guides: