NZ Shared Digital Health Record API
1.0.0 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

Resource Profile: SDHRCondition

Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRCondition Version: 1.0.0
Active as of 2025-11-18 Computable Name: SDHRCondition

Condition resource to record problems and conditions affecting a person

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
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: con-3, con-4, con-5
... meta Σ 1..1 Meta Metadata about the resource
.... source ΣC 1..1 uri Captures the source of the record - please see description for details
Constraints: hpi-location-url-format
.... 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)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:long-term-condition 0..1 boolean Long Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
.... extension:ClientLastUpdated 0..1 dateTime Client Last Updated
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
.... extension:Highlighted 0..1 boolean HNZ SDHR Highlighted
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
.... 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
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.
... code Σ 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: Condition/Problem/DiagnosisCodes (preferred)
... subject Σ 1..1 Reference(Patient) Who has the condition?
.... 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
... onset[x] Σ 0..1 dateTime Estimated or actual date, date-time, or age
... recorder Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
... asserter Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.meta.tag Base preferred ValueSet for SDHR Resource Tags 📦1.0.0 This IG
Condition.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.code Base preferred Condition/Problem/Diagnosis Codes 📦4.0.1 FHIR Std.
Condition.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition 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 Condition 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 Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition 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()
hpi-location-url-format error Condition.meta.source Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format error Condition.subject.reference Reference 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})$')

This structure is derived from NzCondition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition 0..* NzCondition Detailed information about conditions, problems or diagnoses
... meta 1..1 Meta Metadata about the resource
.... source C 1..1 uri Captures the source of the record - please see description for details
Constraints: hpi-location-url-format
.... 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)
... contained 0..0 Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:ClientLastUpdated 0..1 dateTime Client Last Updated
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
.... extension:Highlighted 0..1 boolean HNZ SDHR Highlighted
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-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.
.... system 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
.... value 1..1 string The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710
Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710
... code 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: Condition/Problem/DiagnosisCodes (preferred)
.... coding
..... userSelected 0..1 boolean Indicates that the value has been selected by a system user
... subject 1..1 Reference(Patient) Who has the condition?
.... 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")
Required Pattern: Patient
... onset[x] 0..1 dateTime Estimated or actual date, date-time, or age
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
... asserter 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Condition.meta.tag Base preferred ValueSet for SDHR Resource Tags 📦1.0.0 This IG
Condition.code Base preferred Condition/Problem/Diagnosis Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
hpi-location-url-format error Condition.meta.source Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format error Condition.subject.reference Reference 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})$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: con-3, con-4, con-5
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..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 ΣC 1..1 uri Captures the source of the record - please see description for details
Constraints: hpi-location-url-format
.... profile Σ 1..1 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 Tag the resource with a code to indicate usability components of the resource
Binding: ValueSet for SDHR Resource Tags (preferred)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:long-term-condition 0..1 boolean Long Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
.... extension:ClientLastUpdated 0..1 dateTime Client Last Updated
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
.... extension:Highlighted 0..1 boolean HNZ SDHR Highlighted
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
... identifier Σ 1..* Identifier A local identifier MUST be added to this section. If used, system MUST be specified.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 .
.... type Σ 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.
.... 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
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.
... category 0..* CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
... severity 0..1 CodeableConcept Subjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.
... code Σ 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: Condition/Problem/DiagnosisCodes (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean Indicates that the value has been selected by a system user
.... text Σ 0..1 string Plain text representation of the concept
... bodySite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... subject Σ 1..1 Reference(Patient) Who has the condition?
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... onset[x] Σ 0..1 dateTime Estimated or actual date, date-time, or age
... abatement[x] C 0..1 When in resolution/remission
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
.... abatementString string
... recordedDate Σ 0..1 dateTime Date record was first recorded
... recorder Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
... asserter Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
... stage C 0..* BackboneElement Stage/grade, usually assessed formally
Constraints: con-1
.... 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
.... summary C 0..1 CodeableConcept Simple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).
.... assessment C 0..* Reference(ClinicalImpression | DiagnosticReport | Observation) Formal record of assessment
.... type 0..1 CodeableConcept Kind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).
... evidence C 0..* BackboneElement Supporting evidence
Constraints: con-2
.... 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
.... code ΣC 0..* CodeableConcept Manifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.
.... detail ΣC 0..* Reference(Resource) Supporting information found elsewhere
... note 0..* Annotation Additional information about the Condition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Condition.meta.tag Base preferred ValueSet for SDHR Resource Tags 📦1.0.0 This IG
Condition.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Condition.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Condition.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.category Base extensible Condition Category Codes 📦4.0.1 FHIR Std.
Condition.severity Base preferred Condition/Diagnosis Severity 📦4.0.1 FHIR Std.
Condition.code Base preferred Condition/Problem/Diagnosis Codes 📦4.0.1 FHIR Std.
Condition.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Condition.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Condition.stage.summary Base example Condition Stage 📦4.0.1 FHIR Std.
Condition.stage.type Base example Condition Stage Type 📦4.0.1 FHIR Std.
Condition.evidence.code Base example Manifestation and Symptom Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
con-1 error Condition.stage Stage SHALL have summary or assessment summary.exists() or assessment.exists()
con-2 error Condition.evidence evidence SHALL have code or details code.exists() or detail.exists()
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition 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 Condition 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 Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition 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()
hpi-location-url-format error Condition.meta.source Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format error Condition.subject.reference Reference 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})$')

This structure is derived from NzCondition

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: con-3, con-4, con-5
... meta Σ 1..1 Meta Metadata about the resource
.... source ΣC 1..1 uri Captures the source of the record - please see description for details
Constraints: hpi-location-url-format
.... 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)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:long-term-condition 0..1 boolean Long Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
.... extension:ClientLastUpdated 0..1 dateTime Client Last Updated
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
.... extension:Highlighted 0..1 boolean HNZ SDHR Highlighted
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
.... 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
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.
... code Σ 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: Condition/Problem/DiagnosisCodes (preferred)
... subject Σ 1..1 Reference(Patient) Who has the condition?
.... 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
... onset[x] Σ 0..1 dateTime Estimated or actual date, date-time, or age
... recorder Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
... asserter Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.meta.tag Base preferred ValueSet for SDHR Resource Tags 📦1.0.0 This IG
Condition.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.code Base preferred Condition/Problem/Diagnosis Codes 📦4.0.1 FHIR Std.
Condition.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition 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 Condition 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 Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition 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()
hpi-location-url-format error Condition.meta.source Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format error Condition.subject.reference Reference 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})$')

Differential View

This structure is derived from NzCondition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition 0..* NzCondition Detailed information about conditions, problems or diagnoses
... meta 1..1 Meta Metadata about the resource
.... source C 1..1 uri Captures the source of the record - please see description for details
Constraints: hpi-location-url-format
.... 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)
... contained 0..0 Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:ClientLastUpdated 0..1 dateTime Client Last Updated
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
.... extension:Highlighted 0..1 boolean HNZ SDHR Highlighted
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-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.
.... system 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
.... value 1..1 string The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710
Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710
... code 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: Condition/Problem/DiagnosisCodes (preferred)
.... coding
..... userSelected 0..1 boolean Indicates that the value has been selected by a system user
... subject 1..1 Reference(Patient) Who has the condition?
.... 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")
Required Pattern: Patient
... onset[x] 0..1 dateTime Estimated or actual date, date-time, or age
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
... asserter 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Condition.meta.tag Base preferred ValueSet for SDHR Resource Tags 📦1.0.0 This IG
Condition.code Base preferred Condition/Problem/Diagnosis Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
hpi-location-url-format error Condition.meta.source Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format error Condition.subject.reference Reference 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})$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: con-3, con-4, con-5
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..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 ΣC 1..1 uri Captures the source of the record - please see description for details
Constraints: hpi-location-url-format
.... profile Σ 1..1 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 Tag the resource with a code to indicate usability components of the resource
Binding: ValueSet for SDHR Resource Tags (preferred)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:long-term-condition 0..1 boolean Long Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
.... extension:ClientLastUpdated 0..1 dateTime Client Last Updated
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
.... extension:Highlighted 0..1 boolean HNZ SDHR Highlighted
URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
... identifier Σ 1..* Identifier A local identifier MUST be added to this section. If used, system MUST be specified.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 .
.... type Σ 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.
.... 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
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.
... category 0..* CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
... severity 0..1 CodeableConcept Subjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.
... code Σ 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: Condition/Problem/DiagnosisCodes (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean Indicates that the value has been selected by a system user
.... text Σ 0..1 string Plain text representation of the concept
... bodySite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... subject Σ 1..1 Reference(Patient) Who has the condition?
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... onset[x] Σ 0..1 dateTime Estimated or actual date, date-time, or age
... abatement[x] C 0..1 When in resolution/remission
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
.... abatementString string
... recordedDate Σ 0..1 dateTime Date record was first recorded
... recorder Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
... asserter Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
... stage C 0..* BackboneElement Stage/grade, usually assessed formally
Constraints: con-1
.... 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
.... summary C 0..1 CodeableConcept Simple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).
.... assessment C 0..* Reference(ClinicalImpression | DiagnosticReport | Observation) Formal record of assessment
.... type 0..1 CodeableConcept Kind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).
... evidence C 0..* BackboneElement Supporting evidence
Constraints: con-2
.... 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
.... code ΣC 0..* CodeableConcept Manifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.
.... detail ΣC 0..* Reference(Resource) Supporting information found elsewhere
... note 0..* Annotation Additional information about the Condition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Condition.meta.tag Base preferred ValueSet for SDHR Resource Tags 📦1.0.0 This IG
Condition.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Condition.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Condition.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.category Base extensible Condition Category Codes 📦4.0.1 FHIR Std.
Condition.severity Base preferred Condition/Diagnosis Severity 📦4.0.1 FHIR Std.
Condition.code Base preferred Condition/Problem/Diagnosis Codes 📦4.0.1 FHIR Std.
Condition.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Condition.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Condition.stage.summary Base example Condition Stage 📦4.0.1 FHIR Std.
Condition.stage.type Base example Condition Stage Type 📦4.0.1 FHIR Std.
Condition.evidence.code Base example Manifestation and Symptom Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
con-1 error Condition.stage Stage SHALL have summary or assessment summary.exists() or assessment.exists()
con-2 error Condition.evidence evidence SHALL have code or details code.exists() or detail.exists()
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition 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 Condition 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 Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition 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()
hpi-location-url-format error Condition.meta.source Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format error Condition.subject.reference Reference 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})$')

This structure is derived from NzCondition

 

Other representations of profile: CSV, Excel, Schematron