NZ Shared Digital Health Record API - Local Development build (v0.3.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
Slices for identifier	Σ	0..*	Identifier	External Ids for this condition Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:HealthRecordKey	SΣ	0..1	Identifier	Health Record Key - unique persistent identifier for this clinical FHIR resource ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: offical
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/health-record-key-id
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Condition.identifier:HealthRecordKey.use	required	Fixed Value: offical 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.subject.type	extensible	Pattern: Patient 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
Slices for identifier		0..*	Identifier	External Ids for this condition Slice: Unordered, Open by value:system
identifier:HealthRecordKey	S	0..1	Identifier	Health Record Key - unique persistent identifier for this clinical FHIR resource
use		0..1	code	fixed to official Fixed Value: offical
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/health-record-key-id
severity		0..0
bodySite		0..0
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
encounter		0..0
onset[x]		0..1	dateTime	Estimated or actual date, date-time, or age
abatement[x]		0..0
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
stage		0..0
Documentation for this format

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
Slices for identifier	Σ	0..*	Identifier	External Ids for this condition Slice: Unordered, Open by value:system
identifier:HealthRecordKey	SΣ	0..1	Identifier	Health Record Key - unique persistent identifier for this clinical FHIR 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
use	?!Σ	0..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: offical
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/health-record-key-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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.
code	Σ	0..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.
subject	Σ	1..1	Reference(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
onset[x]	Σ	0..1	dateTime	Estimated or actual date, date-time, or age
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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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:HealthRecordKey.use	required	Fixed Value: offical http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Condition.identifier:HealthRecordKey.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.code	example	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	ResourceType 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-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: 1 element(3 nested mandatory elements)
Must-Support: 1 element
Fixed: 2 elements
Prohibited: 7 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Condition.identifier

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
Slices for identifier	Σ	0..*	Identifier	External Ids for this condition Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:HealthRecordKey	SΣ	0..1	Identifier	Health Record Key - unique persistent identifier for this clinical FHIR resource ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: offical
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/health-record-key-id
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Condition.identifier:HealthRecordKey.use	required	Fixed Value: offical 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.subject.type	extensible	Pattern: Patient 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
Slices for identifier		0..*	Identifier	External Ids for this condition Slice: Unordered, Open by value:system
identifier:HealthRecordKey	S	0..1	Identifier	Health Record Key - unique persistent identifier for this clinical FHIR resource
use		0..1	code	fixed to official Fixed Value: offical
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/health-record-key-id
severity		0..0
bodySite		0..0
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
encounter		0..0
onset[x]		0..1	dateTime	Estimated or actual date, date-time, or age
abatement[x]		0..0
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
stage		0..0
Documentation for this format

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
Slices for identifier	Σ	0..*	Identifier	External Ids for this condition Slice: Unordered, Open by value:system
identifier:HealthRecordKey	SΣ	0..1	Identifier	Health Record Key - unique persistent identifier for this clinical FHIR 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
use	?!Σ	0..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: offical
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/health-record-key-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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.
code	Σ	0..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.
subject	Σ	1..1	Reference(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
onset[x]	Σ	0..1	dateTime	Estimated or actual date, date-time, or age
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).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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:HealthRecordKey.use	required	Fixed Value: offical http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Condition.identifier:HealthRecordKey.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.code	example	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	ResourceType 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-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: 1 element(3 nested mandatory elements)
Must-Support: 1 element
Fixed: 2 elements
Prohibited: 7 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Condition.identifier

Other representations of profile: CSV, Excel, Schematron