Type
|
Reference
|
Content
|
web
|
github.com
|
A schema definition and examples for Request-Context
can be found here
|
web
|
fhir-ig.digital.health.nz
|
View FHIR OpenAPI
|
web
|
fhir-ig.digital.health.nz
|
View Bulk OpenAPI
|
web
|
github.com
|
IG © 2025+ Health New Zealand
. Package tewhatuora.fhir.nz-shared-digital-health-record#0.3.0 based on FHIR 4.0.1
. Generated 2025-03-10
Links: Table of Contents |
QA Report
|
web
|
fhir-ig.digital.health.nz
|
«Encounter»
SDHR:Encounter
Represents a SDHR encounter
https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHREncounter.html
Inherits FHIR
Encounter
meta.source
:
1..1
"https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}"
meta.profile
:
1..1
"https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHREncounter"
identifier
:
1..*
*
identifier[*].system
: "https://standards.digital.health.nz/ns/health-record-key-id"
*identifier[*].value": "health-record-key-id"
status:1..1Binding: EncounterStatus
class:1..1Binding: ActEncounterCode (extensible)
subject
:
1..1
Reference NHI Patient
|
web
|
fhir-ig.digital.health.nz
|
«Encounter»
SDHR:Encounter
Represents a SDHR encounter
https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHREncounter.html
Inherits FHIR
Encounter
meta.source
:
1..1
"https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}"
meta.profile
:
1..1
"https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHREncounter"
identifier
:
1..*
*
identifier[*].system
: "https://standards.digital.health.nz/ns/health-record-key-id"
*identifier[*].value": "health-record-key-id"
status:1..1Binding: EncounterStatus
class:1..1Binding: ActEncounterCode (extensible)
subject
:
1..1
Reference NHI Patient
|
web
|
fhir-ig.digital.health.nz
|
«Condition»
SDHR:Condition
Represents a SDHR condition
https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHRCondition.html
Inherits FHIR
Condition
meta.source
:
1..1
"https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}"
meta.profile
:
1..1
"https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRCondition"
identifier
:
1..*
*
identifier[*].system
: "https://standards.digital.health.nz/ns/health-record-key-id"
*identifier[*].value" : "health-record-key-id"
extension
:
1..*
extentension[*].url
: "http://hl7.org.nz/fhir/StructureDefinition/long-term-condition"
extension[*].valueBoolean
: boolean true|false
clinicalStatus:1..1Binding: ConditionClinicalStatusCodes (required)
verificationStatus:1..1Binding: ConditionVerificationStatus (required)
code
: Binding:
1..1
Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS
subject
:
1..1
Reference NHI Patient
onsetDateTime
:
0..1
Preferred
recordedDateTime
:
0..1
Preferred
recorder
:
0..1
Reference Practitioner (preferred)
asserter
:
1..1
Reference Practitioner
|
web
|
fhir-ig.digital.health.nz
|
«Condition»
SDHR:Condition
Represents a SDHR condition
https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHRCondition.html
Inherits FHIR
Condition
meta.source
:
1..1
"https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}"
meta.profile
:
1..1
"https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRCondition"
identifier
:
1..*
*
identifier[*].system
: "https://standards.digital.health.nz/ns/health-record-key-id"
*identifier[*].value" : "health-record-key-id"
extension
:
1..*
extentension[*].url
: "http://hl7.org.nz/fhir/StructureDefinition/long-term-condition"
extension[*].valueBoolean
: boolean true|false
clinicalStatus:1..1Binding: ConditionClinicalStatusCodes (required)
verificationStatus:1..1Binding: ConditionVerificationStatus (required)
code
: Binding:
1..1
Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS
subject
:
1..1
Reference NHI Patient
onsetDateTime
:
0..1
Preferred
recordedDateTime
:
0..1
Preferred
recorder
:
0..1
Reference Practitioner (preferred)
asserter
:
1..1
Reference Practitioner
|
web
|
fhir-ig.digital.health.nz
|
«AllergyIntolerance»
SDHR:AllergyIntolerance
Represents a SDHR allergy intolerance
https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHRAllergyIntolerance.html
Inherits FHIR
AllergyIntolerance
meta.source
:
1..1
"https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}"
meta.profile
:
1..1
"https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance"
identifier
:
1..*
*
identifier[*].system
: "https://standards.digital.health.nz/ns/health-record-key-id"
*identifier[*].value" : "health-record-key-id"
clinicalStatus:1..1Binding: AllergyIntoleranceClinicalStatus (required)
verificationStatus:1..1Binding: AllergyIntoleranceVerificationStatus (required)
code
:
1..1
Binding: Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS
subject
:
1..1
Reference NHI Patient
category:0..*Binding: AllergyIntoleranceCategory (preferred)
recordedDateTime
: 0..1 (preferred)
recorder
: 0..1 Reference Practitioner (preferred)
|
web
|
fhir-ig.digital.health.nz
|
«AllergyIntolerance»
SDHR:AllergyIntolerance
Represents a SDHR allergy intolerance
https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHRAllergyIntolerance.html
Inherits FHIR
AllergyIntolerance
meta.source
:
1..1
"https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}"
meta.profile
:
1..1
"https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance"
identifier
:
1..*
*
identifier[*].system
: "https://standards.digital.health.nz/ns/health-record-key-id"
*identifier[*].value" : "health-record-key-id"
clinicalStatus:1..1Binding: AllergyIntoleranceClinicalStatus (required)
verificationStatus:1..1Binding: AllergyIntoleranceVerificationStatus (required)
code
:
1..1
Binding: Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS
subject
:
1..1
Reference NHI Patient
category:0..*Binding: AllergyIntoleranceCategory (preferred)
recordedDateTime
: 0..1 (preferred)
recorder
: 0..1 Reference Practitioner (preferred)
|
web
|
fhir-ig.digital.health.nz
|
«Observation»
SDHR:Observation
Represents a SDHR observation
https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHRObservation.html
Inherits FHIR
Observation
meta.source
:
1..1
"https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}"
meta.profile
:
1..1
"https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRObservation"
identifier
:
1..*
*
identifier[*].system
: "https://standards.digital.health.nz/ns/health-record-key-id"
*identifier[*].value" : "health-record-key-id"
code
: Binding: Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS
subject
: Reference NHI Patient
effectiveDateTime
: Preferred
value[x]
: Binding: Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS
interpretation: Binding: ObservationInterpretation (extensible)
status: Binding: ObservationStatus (required)
|
web
|
fhir-ig.digital.health.nz
|
«Observation»
SDHR:Observation
Represents a SDHR observation
https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHRObservation.html
Inherits FHIR
Observation
meta.source
:
1..1
"https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}"
meta.profile
:
1..1
"https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRObservation"
identifier
:
1..*
*
identifier[*].system
: "https://standards.digital.health.nz/ns/health-record-key-id"
*identifier[*].value" : "health-record-key-id"
code
: Binding: Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS
subject
: Reference NHI Patient
effectiveDateTime
: Preferred
value[x]
: Binding: Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS
interpretation: Binding: ObservationInterpretation (extensible)
status: Binding: ObservationStatus (required)
|
web
|
apistandards.digital.health.nz
|
This FHIR API supports authorised submission of and access to Aotearoa patients shared digital health records. Data will be stored and surfaced to authorised Health consumers
and the patient
themselves as part of their personal health record.
|
web
|
apistandards.digital.health.nz
|
This FHIR API supports authorised submission of and access to Aotearoa patients shared digital health records. Data will be stored and surfaced to authorised Health consumers
and the patient
themselves as part of their personal health record.
|
web
|
apistandards.digital.health.nz
|
The Shared Digital Health Record (SDHR) API
allows collection of a patient's clinical information from ministry, primary and secondary care systems, allowing information to be surfaced back to authorised health sector
API consumers
.
|
web
|
apistandards.digital.health.nz
|
The Shared Digital Health Record (SDHR) API
allows collection of a patient's clinical information from ministry, primary and secondary care systems, allowing information to be surfaced back to authorised health sector
API consumers
.
|
web
|
apistandards.digital.health.nz
|
The Shared Digital Health Record (SDHR) API
allows collection of a patient's clinical information from ministry, primary and secondary care systems, allowing information to be surfaced back to authorised health sector
API consumers
.
|
web
|
healthnz-prm.gitlab.io
|
Immunization
|