Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOCondition | Version: 1.0.1 | |||
| Draft as of 2026-07-20 | Computable Name: DHOCondition | |||
This profile derives from the Condition Resource for use in the Dunedin Hospital Outpatients context.
Dunedin Hospital Outpatient Conditions profile
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Condition |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5 |
  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. |
  subject |
Σ | 1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Who has the condition? |
  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 |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
 value |
ΣC | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456 |
| onset[x] |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
| abatement[x] |
C | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
| recorder |
Σ | 0..1 | Reference(Practitioner) | Who recorded the condition |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📍4.0.1 | FHIR Std. |
| Condition.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Condition.subject.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| 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()
|
| dho-nhi-value-format | error | Condition.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| 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()
|
This structure is derived from Condition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Condition |
0..* | Condition | Detailed information about conditions, problems or diagnoses | |
 implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Contained, inline Resources | ||
 modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | External Ids for this condition | ||
| bodySite |
0..0 | Anatomical location, if relevant | ||
| subject |
1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Who has the condition? | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format |
| encounter |
0..0 | Encounter created as part of | ||
| onset[x] |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| abatement[x] |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| recorder |
0..1 | Reference(Practitioner) | Who recorded the condition | |
| asserter |
0..0 | Person who asserts this condition | ||
| stage |
0..0 | Stage/grade, usually assessed formally | ||
| evidence |
0..0 | Supporting evidence | ||
| note |
0..0 | Additional information about the Condition | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| dho-nhi-value-format | error | Condition.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Condition |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5 |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| 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 | |
 extension |
0..* | Extension | Additional content defined by implementations | |
| 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 |
Σ | 0..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. |
| subject |
Σ | 1..1 | Reference(DHO Patient Profile | NZ Patient | 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 | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| 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 |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| 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 | usual | official | temp | secondary | old (If known) 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 | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
| value |
ΣC | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456 |
| 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) |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| onset[x] |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
| abatement[x] |
C | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
| recordedDate |
Σ | 0..1 | dateTime | Date record was first recorded |
| recorder |
Σ | 0..1 | Reference(Practitioner) | Who recorded the condition |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Condition.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Condition.subject.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Condition.subject.identifier.type | Base | extensible | IdentifierType | 📍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. |
| 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()
|
| dho-nhi-value-format | error | Condition.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| 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()
|
This structure is derived from Condition
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Condition |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5 |
| 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. |
| subject |
Σ | 1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Who has the condition? |
| 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 |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
| value |
ΣC | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456 |
| onset[x] |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
| abatement[x] |
C | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
| recorder |
Σ | 0..1 | Reference(Practitioner) | Who recorded the condition |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Condition.clinicalStatus | Base | required | Condition Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| Condition.verificationStatus | Base | required | ConditionVerificationStatus | 📍4.0.1 | FHIR Std. |
| Condition.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Condition.subject.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| 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()
|
| dho-nhi-value-format | error | Condition.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| 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()
|
Differential View
This structure is derived from Condition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Condition |
0..* | Condition | Detailed information about conditions, problems or diagnoses | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Contained, inline Resources | ||
| modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | External Ids for this condition | ||
| bodySite |
0..0 | Anatomical location, if relevant | ||
| subject |
1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Who has the condition? | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format |
| encounter |
0..0 | Encounter created as part of | ||
| onset[x] |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| abatement[x] |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| recorder |
0..1 | Reference(Practitioner) | Who recorded the condition | |
| asserter |
0..0 | Person who asserts this condition | ||
| stage |
0..0 | Stage/grade, usually assessed formally | ||
| evidence |
0..0 | Supporting evidence | ||
| note |
0..0 | Additional information about the Condition | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| dho-nhi-value-format | error | Condition.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Condition |
C | 0..* | Condition | Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5 |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| 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 | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| 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 |
Σ | 0..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. |
| subject |
Σ | 1..1 | Reference(DHO Patient Profile | NZ Patient | 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 | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| 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 |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| 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 | usual | official | temp | secondary | old (If known) 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 | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
| value |
ΣC | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456 |
| 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) |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| onset[x] |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
| abatement[x] |
C | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
| recordedDate |
Σ | 0..1 | dateTime | Date record was first recorded |
| recorder |
Σ | 0..1 | Reference(Practitioner) | Who recorded the condition |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Condition.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Condition.subject.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Condition.subject.identifier.type | Base | extensible | IdentifierType | 📍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. |
| 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()
|
| dho-nhi-value-format | error | Condition.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| 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()
|
This structure is derived from Condition
Other representations of profile: CSV, Excel, Schematron