NZ Shared Digital Health Record API - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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

Usage:

• Examples for this Resource Profile: Condition/HypertensionConditionExample and Condition/RespiratoryConditionExample
• CapabilityStatements using this Resource Profile: NZ Shared Digital Health Record API

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
Condition	C	0..*	NzCondition	Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	0..*	Identifier	A local identifier MAY be added to this section. If used, system MUST be specified. ele-1: All FHIR elements must have a @value or children
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 . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	System for the local identifier. This MUST be consistent per PMS/Health Application ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
code	Σ	1..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (preferred) ele-1: All FHIR elements must have a @value or children
subject	Σ	1..1	Reference(Patient)	Who has the condition? ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008 ele-1: All FHIR elements must have a @value or children
type	Σ	0..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). ele-1: All FHIR elements must have a @value or children Required Pattern: Patient
onset[x]	Σ	0..1	dateTime	Estimated or actual date, date-time, or age ele-1: All FHIR elements must have a @value or children
asserter	Σ	1..1	Reference(Practitioner)	Person who asserts this condition ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ ele-1: All FHIR elements must have a @value or children
type	Σ	0..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). ele-1: All FHIR elements must have a @value or children Required Pattern: Practitioner
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Condition.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Condition.clinicalStatus	required	ConditionClinicalStatusCodes http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard
Condition.verificationStatus	required	ConditionVerificationStatus http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard
Condition.code	preferred	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard
Condition.subject.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Condition.asserter.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from NzCondition

Name	Flags	Card.	Type	Description & Constraints
Condition		0..*	NzCondition	Detailed information about conditions, problems or diagnoses
meta
source		1..1	uri	Captures the source of the record - please see description for details
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
contained		0..0
modifierExtension		0..0
identifier		0..*	Identifier	A local identifier MAY 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		0..1	string	Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008
type		0..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
asserter		1..1	Reference(Practitioner)	Person who asserts this condition
reference		0..1	string	Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ
type		0..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Practitioner
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Condition.code	preferred	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Condition	C	0..*	NzCondition	Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..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	Σ	1..1	uri	Captures the source of the record - please see description for details
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
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	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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
identifier	Σ	0..*	Identifier	A local identifier MAY 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	0..1	string	Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008
type	Σ	0..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)	Who recorded the condition
asserter	Σ	1..1	Reference(Practitioner)	Person who asserts this 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	Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ
type	Σ	0..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: Practitioner
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
stage	C	0..*	BackboneElement	Stage/grade, usually assessed formally con-1: Stage SHALL have summary or assessment
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 con-2: evidence SHALL have code or details
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Condition.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Condition.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Condition.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Condition.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Condition.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Condition.clinicalStatus	required	ConditionClinicalStatusCodes http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard
Condition.verificationStatus	required	ConditionVerificationStatus http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard
Condition.category	extensible	ConditionCategoryCodes http://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard
Condition.severity	preferred	Condition/DiagnosisSeverity http://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard
Condition.code	preferred	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard
Condition.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Condition.subject.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Condition.asserter.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Condition.stage.summary	example	ConditionStage http://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard
Condition.stage.type	example	ConditionStageType http://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard
Condition.evidence.code	example	ManifestationAndSymptomCodes http://hl7.org/fhir/ValueSet/manifestation-or-symptom from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from NzCondition

Summary

Mandatory: 2 elements(4 nested mandatory elements)
Prohibited: 2 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Condition	C	0..*	NzCondition	Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	0..*	Identifier	A local identifier MAY be added to this section. If used, system MUST be specified. ele-1: All FHIR elements must have a @value or children
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 . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	System for the local identifier. This MUST be consistent per PMS/Health Application ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
code	Σ	1..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (preferred) ele-1: All FHIR elements must have a @value or children
subject	Σ	1..1	Reference(Patient)	Who has the condition? ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008 ele-1: All FHIR elements must have a @value or children
type	Σ	0..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). ele-1: All FHIR elements must have a @value or children Required Pattern: Patient
onset[x]	Σ	0..1	dateTime	Estimated or actual date, date-time, or age ele-1: All FHIR elements must have a @value or children
asserter	Σ	1..1	Reference(Practitioner)	Person who asserts this condition ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ ele-1: All FHIR elements must have a @value or children
type	Σ	0..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). ele-1: All FHIR elements must have a @value or children Required Pattern: Practitioner
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Condition.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Condition.clinicalStatus	required	ConditionClinicalStatusCodes http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard
Condition.verificationStatus	required	ConditionVerificationStatus http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard
Condition.code	preferred	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard
Condition.subject.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Condition.asserter.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Differential View

This structure is derived from NzCondition

Name	Flags	Card.	Type	Description & Constraints
Condition		0..*	NzCondition	Detailed information about conditions, problems or diagnoses
meta
source		1..1	uri	Captures the source of the record - please see description for details
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
contained		0..0
modifierExtension		0..0
identifier		0..*	Identifier	A local identifier MAY 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		0..1	string	Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008
type		0..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
asserter		1..1	Reference(Practitioner)	Person who asserts this condition
reference		0..1	string	Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ
type		0..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Practitioner
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Condition.code	preferred	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Condition	C	0..*	NzCondition	Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..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	Σ	1..1	uri	Captures the source of the record - please see description for details
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
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	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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
identifier	Σ	0..*	Identifier	A local identifier MAY 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	0..1	string	Must be an absolute URL reference to the patient on the NHI system. E.g. https://api.hip.digital.health.nz/fhir/Patient/ZZZ0008
type	Σ	0..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)	Who recorded the condition
asserter	Σ	1..1	Reference(Practitioner)	Person who asserts this 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	Must be an absolute URL reference to the practitioner on the HPI system E.g. https://api.hip.digital.health.nz/fhir/Practitioner/99ZZZZ
type	Σ	0..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: Practitioner
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
stage	C	0..*	BackboneElement	Stage/grade, usually assessed formally con-1: Stage SHALL have summary or assessment
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 con-2: evidence SHALL have code or details
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Condition.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Condition.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Condition.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Condition.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Condition.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Condition.clinicalStatus	required	ConditionClinicalStatusCodes http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard
Condition.verificationStatus	required	ConditionVerificationStatus http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard
Condition.category	extensible	ConditionCategoryCodes http://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard
Condition.severity	preferred	Condition/DiagnosisSeverity http://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard
Condition.code	preferred	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard
Condition.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Condition.subject.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Condition.asserter.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Condition.stage.summary	example	ConditionStage http://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard
Condition.stage.type	example	ConditionStageType http://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard
Condition.evidence.code	example	ManifestationAndSymptomCodes http://hl7.org/fhir/ValueSet/manifestation-or-symptom from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from NzCondition

Summary

Mandatory: 2 elements(4 nested mandatory elements)
Prohibited: 2 elements

Other representations of profile: CSV, Excel, Schematron