Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NZ SharedCare Encounter

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareEncounter Version: 0.0.1
Draft as of 2025-08-31 Computable Name: SharedCareEncounter

A FHIR resource profile for NZ SharedCare Encounters.

diagnosis.condition: Do we need a condition profile for this?

This profile is used to represent SharedCare encounters in New Zealand

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cscNumber 0..1 Identifier CSC Number
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number
.... extension:accident 0..1 boolean Accident Related
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/accident
.... extension:regCode 0..1 string Registration Code
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/reg-code
.... extension:triageCategory 0..1 code Triage Category
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/triage-category
Binding: Australasian Triage Scale (required)
.... extension:modeOfArrival 0..1 Coding The method of arrival of the patient into the facility
URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival
Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
... subject Σ 1..1 Reference(Patient) The patient or group present at the encounter
... participant Σ 0..* BackboneElement Practitioners involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... individual Σ 0..1 Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(NZ SharedCare Appointment) The appointment that scheduled this encounter
... hospitalization 0..1 BackboneElement Admission & discharge details (if applicable)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... location 0..* BackboneElement (Sub)Locations where the patient has been during the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Location the encounter takes place
... partOf 0..1 Reference(Encounter) A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... meta
.... source 1..1 uri HPI Facility ID from where the record is sourced
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cscNumber 0..1 Identifier CSC Number
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number
.... extension:accident 0..1 boolean Accident Related
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/accident
.... extension:regCode 0..1 string Registration Code
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/reg-code
.... extension:triageCategory 0..1 code Triage Category
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/triage-category
Binding: Australasian Triage Scale (required)
.... extension:modeOfArrival 0..1 Coding The method of arrival of the patient into the facility
URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival
Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility.
... identifier 1..* Identifier External (provider) and Health NZ business identifiers
... participant 0..* BackboneElement Practitioners involved in the encounter
.... individual 0..1 Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) Persons involved in the encounter other than the patient
... appointment 0..* Reference(NZ SharedCare Appointment) The appointment that scheduled this encounter
... diagnosis
.... condition 1..1 Reference(Condition) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: Diagnosis Use Codes (extensible)
... hospitalization 0..1 BackboneElement Admission & discharge details (if applicable)
... location 0..* BackboneElement (Sub)Locations where the patient has been during the encounter
... partOf 0..1 Reference(Encounter) A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.diagnosis.useextensibleDiagnosisUseCodes
https://fhir-ig.digital.health.nz/shared-care/ValueSet/diagnosis-use-codes
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 1..1 uri HPI Facility ID from where the record is sourced
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cscNumber 0..1 Identifier CSC Number
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number
.... extension:accident 0..1 boolean Accident Related
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/accident
.... extension:regCode 0..1 string Registration Code
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/reg-code
.... extension:triageCategory 0..1 code Triage Category
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/triage-category
Binding: Australasian Triage Scale (required)
.... extension:modeOfArrival 0..1 Coding The method of arrival of the patient into the facility
URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival
Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External (provider) and Health NZ business identifiers
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject Σ 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement Practitioners involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(NZ SharedCare Appointment) The appointment that scheduled this encounter
... period 0..1 Period The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: Diagnosis Use Codes (extensible)
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Admission & discharge details (if applicable)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location 0..* BackboneElement (Sub)Locations where the patient has been during the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 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.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Encounter.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.diagnosis.useextensibleDiagnosisUseCodes
https://fhir-ig.digital.health.nz/shared-care/ValueSet/diagnosis-use-codes
From this IG
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
From the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
From the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cscNumber 0..1 Identifier CSC Number
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number
.... extension:accident 0..1 boolean Accident Related
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/accident
.... extension:regCode 0..1 string Registration Code
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/reg-code
.... extension:triageCategory 0..1 code Triage Category
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/triage-category
Binding: Australasian Triage Scale (required)
.... extension:modeOfArrival 0..1 Coding The method of arrival of the patient into the facility
URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival
Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
... subject Σ 1..1 Reference(Patient) The patient or group present at the encounter
... participant Σ 0..* BackboneElement Practitioners involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... individual Σ 0..1 Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(NZ SharedCare Appointment) The appointment that scheduled this encounter
... hospitalization 0..1 BackboneElement Admission & discharge details (if applicable)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... location 0..* BackboneElement (Sub)Locations where the patient has been during the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Location the encounter takes place
... partOf 0..1 Reference(Encounter) A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... meta
.... source 1..1 uri HPI Facility ID from where the record is sourced
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cscNumber 0..1 Identifier CSC Number
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number
.... extension:accident 0..1 boolean Accident Related
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/accident
.... extension:regCode 0..1 string Registration Code
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/reg-code
.... extension:triageCategory 0..1 code Triage Category
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/triage-category
Binding: Australasian Triage Scale (required)
.... extension:modeOfArrival 0..1 Coding The method of arrival of the patient into the facility
URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival
Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility.
... identifier 1..* Identifier External (provider) and Health NZ business identifiers
... participant 0..* BackboneElement Practitioners involved in the encounter
.... individual 0..1 Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) Persons involved in the encounter other than the patient
... appointment 0..* Reference(NZ SharedCare Appointment) The appointment that scheduled this encounter
... diagnosis
.... condition 1..1 Reference(Condition) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: Diagnosis Use Codes (extensible)
... hospitalization 0..1 BackboneElement Admission & discharge details (if applicable)
... location 0..* BackboneElement (Sub)Locations where the patient has been during the encounter
... partOf 0..1 Reference(Encounter) A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.diagnosis.useextensibleDiagnosisUseCodes
https://fhir-ig.digital.health.nz/shared-care/ValueSet/diagnosis-use-codes
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 1..1 uri HPI Facility ID from where the record is sourced
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cscNumber 0..1 Identifier CSC Number
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/csc-number
.... extension:accident 0..1 boolean Accident Related
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/accident
.... extension:regCode 0..1 string Registration Code
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/reg-code
.... extension:triageCategory 0..1 code Triage Category
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/triage-category
Binding: Australasian Triage Scale (required)
.... extension:modeOfArrival 0..1 Coding The method of arrival of the patient into the facility
URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival
Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External (provider) and Health NZ business identifiers
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject Σ 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement Practitioners involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(NZ SharedCare Appointment) The appointment that scheduled this encounter
... period 0..1 Period The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: Diagnosis Use Codes (extensible)
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Admission & discharge details (if applicable)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location 0..* BackboneElement (Sub)Locations where the patient has been during the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 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.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Encounter.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.diagnosis.useextensibleDiagnosisUseCodes
https://fhir-ig.digital.health.nz/shared-care/ValueSet/diagnosis-use-codes
From this IG
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
From the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
From the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron