Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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: DHOCondition

This profile derives from the Condition Resource for use in the Dunedin Hospital Outpatients context.

Dunedin Hospital Outpatient Conditions profile

Usages:

• Examples for this Profile: Condition/DHOConditionExample
• CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

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..*	Condition	Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5
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.subject	Σ This element is included in summaries.	1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	Who has the condition?
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
Condition.subject.identifier	Σ This element is included in summaries.	1..1	Identifier	Logical reference, when literal reference is not known
Condition.subject.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Condition.subject.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Condition.subject.identifier.value	Σ 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: dho-nhi-value-format Example General: 123456
Condition.onset[x]	Σ This element is included in summaries.	0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.abatement[x]	C	0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.recorder	Σ This element is included in summaries.	0..1	Reference(Practitioner)	Who recorded the condition
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Condition.clinicalStatus	Base	required	Condition Clinical Status Codes	📍4.0.1	FHIR Std.
Condition.verificationStatus	Base	required	ConditionVerificationStatus	📍4.0.1	FHIR Std.
Condition.subject.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Condition.subject.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dho-nhi-value-format	error	Condition.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

This structure is derived from Condition

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition		0..*	Condition	Detailed information about conditions, problems or diagnoses
Condition.implicitRules		0..0		A set of rules under which this content was created
Condition.language		0..0		Language of the resource content
Condition.contained		0..0		Contained, inline Resources
Condition.modifierExtension		0..0		Extension
Condition.identifier		0..0		External Ids for this condition
Condition.bodySite		0..0		Anatomical location, if relevant
Condition.subject		1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	Who has the condition?
Condition.subject.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
Condition.subject.identifier		1..1	Identifier	Logical reference, when literal reference is not known
Condition.subject.identifier.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Condition.subject.identifier.value	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format
Condition.encounter		0..0		Encounter created as part of
Condition.onset[x]		0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.abatement[x]		0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.recorder		0..1	Reference(Practitioner)	Who recorded the condition
Condition.asserter		0..0		Person who asserts this condition
Condition.stage		0..0		Stage/grade, usually assessed formally
Condition.evidence		0..0		Supporting evidence
Condition.note		0..0		Additional information about the Condition
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
dho-nhi-value-format	error	Condition.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition	C	0..*	Condition	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.	0..1	Meta	Metadata about the resource
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.extension		0..*	Extension	Additional content defined by implementations
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	problem-list-item | encounter-diagnosis 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.	0..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.
Condition.subject	Σ This element is included in summaries.	1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	Who has the condition?
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	0..1	string	Literal reference, Relative, internal or absolute URL
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
Condition.subject.identifier	Σ This element is included in summaries.	1..1	Identifier	Logical reference, when literal reference is not known
Condition.subject.identifier.id		0..1	string	Unique id for inter-element referencing
Condition.subject.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.subject.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Condition.subject.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.subject.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Condition.subject.identifier.value	Σ 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: dho-nhi-value-format Example General: 123456
Condition.subject.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Condition.subject.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Condition.subject.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Condition.onset[x]	Σ This element is included in summaries.	0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.abatement[x]	C	0..1	dateTime	Must be in UTC timezone on the FHIR server
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)	Who recorded the condition
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Condition.clinicalStatus	Base	required	Condition Clinical Status Codes	📍4.0.1	FHIR Std.
Condition.verificationStatus	Base	required	ConditionVerificationStatus	📍4.0.1	FHIR Std.
Condition.category	Base	extensible	Condition Category Codes	📍4.0.1	FHIR Std.
Condition.severity	Base	preferred	Condition/Diagnosis Severity	📍4.0.1	FHIR Std.
Condition.code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
Condition.subject.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Condition.subject.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Condition.subject.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Condition.stage.summary	Base	example	Condition Stage	📍4.0.1	FHIR Std.
Condition.stage.type	Base	example	Condition Stage Type	📍4.0.1	FHIR Std.
Condition.evidence.code	Base	example	Manifestation and Symptom Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dho-nhi-value-format	error	Condition.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

This structure is derived from Condition

Summary

Mandatory: 4 elements
Fixed: 1 element
Prohibited: 11 elements

Structures

This structure refers to these other structures:

• DHO Patient Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOPatient)
• NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition	C	0..*	Condition	Detailed information about conditions, problems or diagnoses Constraints: con-3, con-4, con-5
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.subject	Σ This element is included in summaries.	1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	Who has the condition?
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
Condition.subject.identifier	Σ This element is included in summaries.	1..1	Identifier	Logical reference, when literal reference is not known
Condition.subject.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Condition.subject.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Condition.subject.identifier.value	Σ 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: dho-nhi-value-format Example General: 123456
Condition.onset[x]	Σ This element is included in summaries.	0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.abatement[x]	C	0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.recorder	Σ This element is included in summaries.	0..1	Reference(Practitioner)	Who recorded the condition
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Condition.clinicalStatus	Base	required	Condition Clinical Status Codes	📍4.0.1	FHIR Std.
Condition.verificationStatus	Base	required	ConditionVerificationStatus	📍4.0.1	FHIR Std.
Condition.subject.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Condition.subject.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dho-nhi-value-format	error	Condition.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

Differential View

This structure is derived from Condition

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition		0..*	Condition	Detailed information about conditions, problems or diagnoses
Condition.implicitRules		0..0		A set of rules under which this content was created
Condition.language		0..0		Language of the resource content
Condition.contained		0..0		Contained, inline Resources
Condition.modifierExtension		0..0		Extension
Condition.identifier		0..0		External Ids for this condition
Condition.bodySite		0..0		Anatomical location, if relevant
Condition.subject		1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	Who has the condition?
Condition.subject.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
Condition.subject.identifier		1..1	Identifier	Logical reference, when literal reference is not known
Condition.subject.identifier.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Condition.subject.identifier.value	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format
Condition.encounter		0..0		Encounter created as part of
Condition.onset[x]		0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.abatement[x]		0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.recorder		0..1	Reference(Practitioner)	Who recorded the condition
Condition.asserter		0..0		Person who asserts this condition
Condition.stage		0..0		Stage/grade, usually assessed formally
Condition.evidence		0..0		Supporting evidence
Condition.note		0..0		Additional information about the Condition
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
dho-nhi-value-format	error	Condition.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Condition	C	0..*	Condition	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.	0..1	Meta	Metadata about the resource
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.extension		0..*	Extension	Additional content defined by implementations
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	problem-list-item | encounter-diagnosis 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.	0..1	CodeableConcept	Identification of the condition, problem or diagnosis Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.
Condition.subject	Σ This element is included in summaries.	1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	Who has the condition?
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	0..1	string	Literal reference, Relative, internal or absolute URL
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
Condition.subject.identifier	Σ This element is included in summaries.	1..1	Identifier	Logical reference, when literal reference is not known
Condition.subject.identifier.id		0..1	string	Unique id for inter-element referencing
Condition.subject.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Condition.subject.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Condition.subject.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.subject.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Condition.subject.identifier.value	Σ 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: dho-nhi-value-format Example General: 123456
Condition.subject.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Condition.subject.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Condition.subject.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Condition.onset[x]	Σ This element is included in summaries.	0..1	dateTime	Must be in UTC timezone on the FHIR server
Condition.abatement[x]	C	0..1	dateTime	Must be in UTC timezone on the FHIR server
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)	Who recorded the condition
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Condition.clinicalStatus	Base	required	Condition Clinical Status Codes	📍4.0.1	FHIR Std.
Condition.verificationStatus	Base	required	ConditionVerificationStatus	📍4.0.1	FHIR Std.
Condition.category	Base	extensible	Condition Category Codes	📍4.0.1	FHIR Std.
Condition.severity	Base	preferred	Condition/Diagnosis Severity	📍4.0.1	FHIR Std.
Condition.code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
Condition.subject.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Condition.subject.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Condition.subject.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Condition.stage.summary	Base	example	Condition Stage	📍4.0.1	FHIR Std.
Condition.stage.type	Base	example	Condition Stage Type	📍4.0.1	FHIR Std.
Condition.evidence.code	Base	example	Manifestation and Symptom Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dho-nhi-value-format	error	Condition.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

This structure is derived from Condition

Summary

Mandatory: 4 elements
Fixed: 1 element
Prohibited: 11 elements

Structures

This structure refers to these other structures:

• DHO Patient Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOPatient)
• NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient)

Other representations of profile: CSV, Excel, Schematron