NZ Shared Digital Health Record API
0.4.0 - draft
NZ Shared Digital Health Record API - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHREncounter | Version: 0.4.0 | |||
Draft as of 2025-05-02 | Computable Name: SDHREncounter |
Encounter resource to record an instance of an interaction between patient and healthcare provider
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
Σ | 0..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System for the local identifier. This MUST be consistent per PMS/Health Application ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient Example Local Identifier System: https://fhir.example.co.nz |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 ele-1: All FHIR elements must have a @value or children Example General: 123456 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008 ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Required Pattern: Patient |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Required Pattern: Practitioner |
![]() |
Path | Conformance | ValueSet / Code | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Encounter.participant.individual.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | uri | Captures the source of the record - please see description for details | |
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. | |
![]() ![]() ![]() ![]() |
0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. | |
![]() ![]() ![]() ![]() |
1..1 | uri | System for the local identifier. This MUST be consistent per PMS/Health Application Example Local Identifier System: https://fhir.example.co.nz | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710 | |
![]() ![]() ![]() |
1..1 | Reference(Patient) | The patient or group present at the encounter | |
![]() ![]() ![]() ![]() |
0..1 | string | Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008 | |
![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
![]() ![]() ![]() |
1..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ | |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Practitioner | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Captures the source of the record - please see description for details |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
Σ | 0..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System for the local identifier. This MUST be consistent per PMS/Health Application Example General: http://www.acme.com/identifiers/patient Example Local Identifier System: https://fhir.example.co.nz |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example General: 123456 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. |
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient or group present at the encounter |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter |
![]() ![]() ![]() |
0..1 | Period | The start and end time of the encounter | |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |
![]() ![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |
![]() ![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Encounter.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant.individual.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | |
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | |
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | |
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | |
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | |
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | |
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | |
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
Σ | 0..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System for the local identifier. This MUST be consistent per PMS/Health Application ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient Example Local Identifier System: https://fhir.example.co.nz |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 ele-1: All FHIR elements must have a @value or children Example General: 123456 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008 ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Required Pattern: Patient |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Required Pattern: Practitioner |
![]() |
Path | Conformance | ValueSet / Code | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Encounter.participant.individual.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | uri | Captures the source of the record - please see description for details | |
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. | |
![]() ![]() ![]() ![]() |
0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. | |
![]() ![]() ![]() ![]() |
1..1 | uri | System for the local identifier. This MUST be consistent per PMS/Health Application Example Local Identifier System: https://fhir.example.co.nz | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710 | |
![]() ![]() ![]() |
1..1 | Reference(Patient) | The patient or group present at the encounter | |
![]() ![]() ![]() ![]() |
0..1 | string | Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008 | |
![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
![]() ![]() ![]() |
1..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ | |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Practitioner | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Captures the source of the record - please see description for details |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
Σ | 0..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System for the local identifier. This MUST be consistent per PMS/Health Application Example General: http://www.acme.com/identifiers/patient Example Local Identifier System: https://fhir.example.co.nz |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example General: 123456 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. |
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient or group present at the encounter |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter |
![]() ![]() ![]() |
0..1 | Period | The start and end time of the encounter | |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |
![]() ![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |
![]() ![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Encounter.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant.individual.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | |
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | |
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | |
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | |
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | |
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | |
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | |
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Other representations of profile: CSV, Excel, Schematron