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.1.6 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: SDHRCondition

Condition resource to record problems and conditions affecting a person

Usages:

• Examples for this Profile: Condition/276c6f2a0-d5fb-42c0-a16d-3625e3c87204 and Condition/ConditionHypertensionExample
• CapabilityStatements using this Profile: NZ Shared Digital Health Record API

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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition	C	0..*	NzCondition	Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5
Condition.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
Condition.meta.source	Σ This element is included in summaries. C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
Condition.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Condition.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
Condition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Condition.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Condition.Slices for extension.extension:long-term-condition		0..1	boolean	Long Term Condition Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
Condition.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
Condition.Slices for extension.extension:Highlighted		0..1	boolean	HNZ SDHR Highlighted URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
Condition.identifier	Σ This element is included in summaries.	1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
Condition.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	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 .
Condition.identifier.system	Σ This element is included in summaries.	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
Condition.identifier.value	Σ This element is included in summaries.	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
Condition.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
Condition.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. 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.
Condition.category		0..*	CodeableConcept	A means of categorising the different types of problem, to distinguish for example, a diagnosis, from a clinical risk Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
Condition.code	Σ This element is included in summaries.	1..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (preferred)
Condition.subject	Σ This element is included in summaries.	1..1	Reference(Patient)	National Health Identifier for the health consumer
Condition.subject.reference	Σ This element is included in summaries. 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
Condition.subject.type	Σ This element is included in summaries.	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 (extensions allowed)
Condition.onset[x]	Σ This element is included in summaries.	0..1	dateTime	Estimated or actual date, date-time, or age
Condition.recorder	Σ This element is included in summaries.	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
Condition.asserter	Σ This element is included in summaries.	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
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Condition.meta.tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	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.category	Base	extensible	Condition Category Codes	📦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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition		0..*	NzCondition	Detailed information about conditions, problems or diagnoses
Condition.meta		1..1	Meta	Metadata about the resource
Condition.meta.source	C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
Condition.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Condition.meta.tag		0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
Condition.contained		0..0		Contained, inline Resources
Condition.extension		1..*	Extension	Extension
Condition.Slices for extension				Content/Rules for all slices
Condition.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
Condition.Slices for extension.extension:Highlighted		0..1	boolean	HNZ SDHR Highlighted URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
Condition.modifierExtension		0..0		Extension
Condition.identifier		1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
Condition.identifier.use		0..1	code	The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier.
Condition.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
Condition.identifier.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
Condition.category		0..*	CodeableConcept	A means of categorising the different types of problem, to distinguish for example, a diagnosis, from a clinical risk
Condition.code		1..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (preferred)
Condition.code.coding
Condition.code.coding.userSelected		0..1	boolean	Indicates that the value has been selected by a system user
Condition.subject		1..1	Reference(Patient)	National Health Identifier for the health consumer
Condition.subject.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
Condition.subject.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient (extensions allowed)
Condition.onset[x]		0..1	dateTime	Estimated or actual date, date-time, or age
Condition.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
Condition.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
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Condition.meta.tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	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})$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition	C	0..*	NzCondition	Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5
Condition.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Condition.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
Condition.meta.id		0..1	string	Unique id for inter-element referencing
Condition.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Condition.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Condition.meta.source	Σ This element is included in summaries. C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
Condition.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Condition.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Condition.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
Condition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Condition.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Condition.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
Condition.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Condition.Slices for extension.extension:long-term-condition		0..1	boolean	Long Term Condition Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
Condition.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
Condition.Slices for extension.extension:Highlighted		0..1	boolean	HNZ SDHR Highlighted URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
Condition.identifier	Σ This element is included in summaries.	1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
Condition.identifier.id		0..1	string	Unique id for inter-element referencing
Condition.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	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 .
Condition.identifier.type	Σ This element is included in summaries.	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.
Condition.identifier.system	Σ This element is included in summaries.	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
Condition.identifier.value	Σ This element is included in summaries.	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
Condition.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Condition.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Condition.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
Condition.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. 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.
Condition.category		0..*	CodeableConcept	A means of categorising the different types of problem, to distinguish for example, a diagnosis, from a clinical risk Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
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.
Condition.code	Σ This element is included in summaries.	1..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (preferred)
Condition.code.id		0..1	string	Unique id for inter-element referencing
Condition.code.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.code.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Condition.code.coding.id		0..1	string	Unique id for inter-element referencing
Condition.code.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.code.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
Condition.code.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Condition.code.coding.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Condition.code.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Condition.code.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	Indicates that the value has been selected by a system user
Condition.code.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Condition.bodySite	Σ This element is included in summaries.	0..*	CodeableConcept	Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Condition.subject	Σ This element is included in summaries.	1..1	Reference(Patient)	National Health Identifier for the health consumer
Condition.subject.id		0..1	string	Unique id for inter-element referencing
Condition.subject.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.subject.reference	Σ This element is included in summaries. 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
Condition.subject.type	Σ This element is included in summaries.	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 (extensions allowed)
Condition.subject.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Condition.subject.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Condition.encounter	Σ This element is included in summaries.	0..1	Reference(Encounter)	Encounter created as part of
Condition.onset[x]	Σ This element is included in summaries.	0..1	dateTime	Estimated or actual date, date-time, or age
Condition.abatement[x]	C	0..1		When in resolution/remission
Condition.abatement[x].abatementDateTime			dateTime
Condition.abatement[x].abatementAge			Age
Condition.abatement[x].abatementPeriod			Period
Condition.abatement[x].abatementRange			Range
Condition.abatement[x].abatementString			string
Condition.recordedDate	Σ This element is included in summaries.	0..1	dateTime	Date record was first recorded
Condition.recorder	Σ This element is included in summaries.	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
Condition.asserter	Σ This element is included in summaries.	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
Condition.stage	C	0..*	BackboneElement	Stage/grade, usually assessed formally Constraints: con-1
Condition.stage.id		0..1	string	Unique id for inter-element referencing
Condition.stage.extension		0..*	Extension	Additional content defined by implementations
Condition.stage.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Condition.stage.summary	C	0..1	CodeableConcept	Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).
Condition.stage.assessment	C	0..*	Reference(ClinicalImpression | DiagnosticReport | Observation)	Formal record of assessment
Condition.stage.type		0..1	CodeableConcept	Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).
Condition.evidence	C	0..*	BackboneElement	Supporting evidence Constraints: con-2
Condition.evidence.id		0..1	string	Unique id for inter-element referencing
Condition.evidence.extension		0..*	Extension	Additional content defined by implementations
Condition.evidence.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Condition.evidence.code	Σ This element is included in summaries. C	0..*	CodeableConcept	Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.
Condition.evidence.detail	Σ This element is included in summaries. C	0..*	Reference(Resource)	Supporting information found elsewhere
Condition.note		0..*	Annotation	Additional information about the Condition
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.1.6	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

Summary

Mandatory: 11 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
• https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition	C	0..*	NzCondition	Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5
Condition.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
Condition.meta.source	Σ This element is included in summaries. C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
Condition.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Condition.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
Condition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Condition.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Condition.Slices for extension.extension:long-term-condition		0..1	boolean	Long Term Condition Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
Condition.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
Condition.Slices for extension.extension:Highlighted		0..1	boolean	HNZ SDHR Highlighted URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
Condition.identifier	Σ This element is included in summaries.	1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
Condition.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	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 .
Condition.identifier.system	Σ This element is included in summaries.	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
Condition.identifier.value	Σ This element is included in summaries.	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
Condition.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
Condition.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. 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.
Condition.category		0..*	CodeableConcept	A means of categorising the different types of problem, to distinguish for example, a diagnosis, from a clinical risk Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
Condition.code	Σ This element is included in summaries.	1..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (preferred)
Condition.subject	Σ This element is included in summaries.	1..1	Reference(Patient)	National Health Identifier for the health consumer
Condition.subject.reference	Σ This element is included in summaries. 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
Condition.subject.type	Σ This element is included in summaries.	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 (extensions allowed)
Condition.onset[x]	Σ This element is included in summaries.	0..1	dateTime	Estimated or actual date, date-time, or age
Condition.recorder	Σ This element is included in summaries.	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
Condition.asserter	Σ This element is included in summaries.	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
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Condition.meta.tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	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.category	Base	extensible	Condition Category Codes	📦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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition		0..*	NzCondition	Detailed information about conditions, problems or diagnoses
Condition.meta		1..1	Meta	Metadata about the resource
Condition.meta.source	C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
Condition.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Condition.meta.tag		0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
Condition.contained		0..0		Contained, inline Resources
Condition.extension		1..*	Extension	Extension
Condition.Slices for extension				Content/Rules for all slices
Condition.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
Condition.Slices for extension.extension:Highlighted		0..1	boolean	HNZ SDHR Highlighted URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
Condition.modifierExtension		0..0		Extension
Condition.identifier		1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
Condition.identifier.use		0..1	code	The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier.
Condition.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
Condition.identifier.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
Condition.category		0..*	CodeableConcept	A means of categorising the different types of problem, to distinguish for example, a diagnosis, from a clinical risk
Condition.code		1..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (preferred)
Condition.code.coding
Condition.code.coding.userSelected		0..1	boolean	Indicates that the value has been selected by a system user
Condition.subject		1..1	Reference(Patient)	National Health Identifier for the health consumer
Condition.subject.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
Condition.subject.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient (extensions allowed)
Condition.onset[x]		0..1	dateTime	Estimated or actual date, date-time, or age
Condition.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
Condition.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
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Condition.meta.tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition	C	0..*	NzCondition	Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5
Condition.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Condition.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
Condition.meta.id		0..1	string	Unique id for inter-element referencing
Condition.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Condition.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Condition.meta.source	Σ This element is included in summaries. C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
Condition.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Condition.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Condition.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
Condition.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Condition.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Condition.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
Condition.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Condition.Slices for extension.extension:long-term-condition		0..1	boolean	Long Term Condition Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
Condition.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
Condition.Slices for extension.extension:Highlighted		0..1	boolean	HNZ SDHR Highlighted URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension
Condition.identifier	Σ This element is included in summaries.	1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
Condition.identifier.id		0..1	string	Unique id for inter-element referencing
Condition.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	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 .
Condition.identifier.type	Σ This element is included in summaries.	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.
Condition.identifier.system	Σ This element is included in summaries.	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
Condition.identifier.value	Σ This element is included in summaries.	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
Condition.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Condition.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Condition.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
Condition.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. 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.
Condition.category		0..*	CodeableConcept	A means of categorising the different types of problem, to distinguish for example, a diagnosis, from a clinical risk Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
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.
Condition.code	Σ This element is included in summaries.	1..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (preferred)
Condition.code.id		0..1	string	Unique id for inter-element referencing
Condition.code.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.code.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
Condition.code.coding.id		0..1	string	Unique id for inter-element referencing
Condition.code.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.code.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
Condition.code.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Condition.code.coding.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Condition.code.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Condition.code.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	Indicates that the value has been selected by a system user
Condition.code.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Condition.bodySite	Σ This element is included in summaries.	0..*	CodeableConcept	Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Condition.subject	Σ This element is included in summaries.	1..1	Reference(Patient)	National Health Identifier for the health consumer
Condition.subject.id		0..1	string	Unique id for inter-element referencing
Condition.subject.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.subject.reference	Σ This element is included in summaries. 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
Condition.subject.type	Σ This element is included in summaries.	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 (extensions allowed)
Condition.subject.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Condition.subject.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Condition.encounter	Σ This element is included in summaries.	0..1	Reference(Encounter)	Encounter created as part of
Condition.onset[x]	Σ This element is included in summaries.	0..1	dateTime	Estimated or actual date, date-time, or age
Condition.abatement[x]	C	0..1		When in resolution/remission
Condition.abatement[x].abatementDateTime			dateTime
Condition.abatement[x].abatementAge			Age
Condition.abatement[x].abatementPeriod			Period
Condition.abatement[x].abatementRange			Range
Condition.abatement[x].abatementString			string
Condition.recordedDate	Σ This element is included in summaries.	0..1	dateTime	Date record was first recorded
Condition.recorder	Σ This element is included in summaries.	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
Condition.asserter	Σ This element is included in summaries.	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
Condition.stage	C	0..*	BackboneElement	Stage/grade, usually assessed formally Constraints: con-1
Condition.stage.id		0..1	string	Unique id for inter-element referencing
Condition.stage.extension		0..*	Extension	Additional content defined by implementations
Condition.stage.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Condition.stage.summary	C	0..1	CodeableConcept	Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).
Condition.stage.assessment	C	0..*	Reference(ClinicalImpression | DiagnosticReport | Observation)	Formal record of assessment
Condition.stage.type		0..1	CodeableConcept	Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).
Condition.evidence	C	0..*	BackboneElement	Supporting evidence Constraints: con-2
Condition.evidence.id		0..1	string	Unique id for inter-element referencing
Condition.evidence.extension		0..*	Extension	Additional content defined by implementations
Condition.evidence.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Condition.evidence.code	Σ This element is included in summaries. C	0..*	CodeableConcept	Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.
Condition.evidence.detail	Σ This element is included in summaries. C	0..*	Reference(Resource)	Supporting information found elsewhere
Condition.note		0..*	Annotation	Additional information about the Condition
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.1.6	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

Summary

Mandatory: 11 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
• https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension

Other representations of profile: CSV, Excel, Schematron