NZ Shared Digital Health Record API
0.7.0 - ballot

NZ Shared Digital Health Record API - Local Development build (v0.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SDHREncounter

Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHREncounter Version: 0.7.0
Draft as of 2025-08-20 Computable Name: SDHREncounter

Encounter resource to record an instance of an interaction between patient and healthcare provider

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
... meta Σ 1..1 Meta Metadata about the resource
.... source Σ 1..1 uri Captures the source of the record - please see description for details
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... tag Σ 0..* Coding Tag the resource with a code to indicate usability components of the resource
Binding: ValueSet for SDHR Resource Tags (preferred)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ClientLastUpdated 0..1 dateTime Client Last Updated
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
... identifier Σ 1..* Identifier A local identifier MUST be added to this section. If used, system MUST be specified.
.... use ?!Σ 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 .
.... system Σ 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
.... value Σ 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
... class Σ 1..1 Coding Classification of patient encounter
Binding: ValueSet for EncounterStatus (required)
... subject Σ 1..1 Reference(Patient) The patient or group present at the encounter
.... reference ΣC 1..1 string Must be an absolute URL reference to the patient on the NHI system. See constraints for details.
Constraints: nhi-url-format
.... type Σ 1..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
... participant Σ 1..* BackboneElement List of participants involved in the encounter
.... individual Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
..... extension 0..0
... period 1..1 Period The start and end time of the encounter
.... start ΣC 1..1 dateTime Starting time with inclusive boundary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.meta.tagpreferredSDHRResourceTagsValueSet
https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-resource-tags-valueset
From this IG
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredSDHREncounterClassValueSet
https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-encounter-class-valueset
From this IG
Encounter.subject.typeextensiblePattern Value: Patient
http://hl7.org/fhir/ValueSet/resource-types
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()
nhi-url-formaterrorEncounter.subject.referenceReference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA
: matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

 

Other representations of profile: CSV, Excel, Schematron