AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build Australia flag

AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions

Resource Profile: AU PS Condition

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-condition Version: 1.0.1-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUPSCondition

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Condition resource in the context of a patient summary in an Australian context. It is based on the AU Core Condition profile, and applies the additional requirements from Condition (IPS).

See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.

Profile specific implementation guidance

The additional obligation on Condition.onsetDateTime for AU PS Producer is SHOULD:able-to-populate. This obligation is in addition to the obligation of SHALL:populate-if-known. There is no additional obligation for AU PS Consumer, the obligations of SHALL:handle and SHOULD:display apply.

This additional obligation is present in the underlying structure but due to a tooling limitation is not currently rendered in the Formal Views of Profile Content. See Zulip discussion for more information.

Examples for this Profile: Bundle/aups-basicsummary, Bundle/aups-gpvisit-retrieval, Bundle/aups-noknownx, Bundle/aups-patient-story, Bundle/aups-referral-endoconsult-autogen and Bundle/aups-referral-endoconsult-curated

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Condition C 0..* AUCoreCondition A condition, problem or diagnosis statement in an Australian healthcare context
This profile also complies with the profile Condition (IPS)
Constraints: con-3, con-4, con-5
Condition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Condition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Condition.clinicalStatus This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConceptIPS active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.verificationStatus This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConceptIPS 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.category This element has obligations and must be supported. 1..* CodeableConceptIPS problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.severity This element has obligations and must be supported. 0..1 CodeableConceptIPS Subjective severity of condition
Binding: Condition/DiagnosisSeverity (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.code This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
Binding: Clinical Condition (extensible)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Condition.onset[x] This element has obligations and must be supported. This element is included in summaries. 0..1 Estimated or actual date, date-time, or age
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.onset[x].onsetDateTime dateTime This target must be supported.
Condition.onset[x].onsetAge Age
Condition.onset[x].onsetPeriod Period
Condition.onset[x].onsetRange Range
Condition.abatement[x] This element has obligations and must be supported. C 0..1 When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.abatement[x].abatementDateTime dateTime
Condition.abatement[x].abatementAge Age
Condition.abatement[x].abatementPeriod Period
Condition.abatement[x].abatementRange Range
Condition.note This element has obligations and must be supported. 0..* Annotation Additional information about the Condition
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco 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 extensible Condition/Diagnosis Severity 📦4.0.1 FHIR Std.
Condition.code Base extensible Clinical Condition ⏿1.0.2 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Condition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AUCoreCondition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Condition 0..* AUCoreCondition A condition, problem or diagnosis statement in an Australian healthcare context
This profile also complies with the profile Condition (IPS)
Condition.clinicalStatus This element has obligations. 0..1 CodeableConceptIPS active | recurrence | relapse | inactive | remission | resolved
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.verificationStatus This element has obligations. 0..1 CodeableConceptIPS unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.category This element has obligations. 1..* CodeableConceptIPS problem-list-item | encounter-diagnosis
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.code This element has obligations. 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject This element has obligations. 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject.reference This element has obligations and must be supported. 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Condition.onset[x] This element has obligations. 0..1 Estimated or actual date, date-time, or age
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.onset[x].onsetDateTime dateTime
Condition.onset[x].onsetAge Age
Condition.onset[x].onsetPeriod Period
Condition.onset[x].onsetRange Range
Condition.abatement[x] This element has obligations. 0..1 dateTime, Age, Period, Range When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.note This element has obligations. 0..* Annotation Additional information about the Condition
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Condition C 0..* AUCoreCondition A condition, problem or diagnosis statement in an Australian healthcare context
This profile also complies with the profile Condition (IPS)
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.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Condition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Condition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Condition.contained 0..* Resource Contained, inline Resources
Condition.extension 0..* Extension Additional content defined by implementations
Condition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Condition.identifier This element is included in summaries. 0..* Identifier External Ids for this condition
Condition.clinicalStatus This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConceptIPS active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.verificationStatus This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConceptIPS 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.category This element has obligations and must be supported. 1..* CodeableConceptIPS problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.severity This element has obligations and must be supported. 0..1 CodeableConceptIPS Subjective severity of condition
Binding: Condition/DiagnosisSeverity (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.code This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
Binding: Clinical Condition (extensible)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.bodySite This element is included in summaries. C 0..* CodeableConcept Anatomical location, if relevant
Binding: Body Site (extensible)
Constraints: au-core-cond-01
Condition.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject.id 0..1 string Unique id for inter-element referencing
Condition.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Condition.subject.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Condition.subject.type This element is included in summaries. 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).
Condition.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Condition.subject.display This element is included in summaries. 0..1 string Text alternative for the resource
Condition.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
Condition.onset[x] This element has obligations and must be supported. This element is included in summaries. 0..1 Estimated or actual date, date-time, or age
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.onset[x].onsetDateTime dateTime This target must be supported.
Condition.onset[x].onsetAge Age
Condition.onset[x].onsetPeriod Period
Condition.onset[x].onsetRange Range
Condition.abatement[x] This element has obligations and must be supported. C 0..1 When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.abatement[x].abatementDateTime dateTime
Condition.abatement[x].abatementAge Age
Condition.abatement[x].abatementPeriod Period
Condition.abatement[x].abatementRange Range
Condition.recordedDate This element is included in summaries. 0..1 dateTime Date record was first recorded
Condition.recorder This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the condition
Condition.asserter This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person who asserts this condition
Condition.stage C 0..* BackboneElement Stage/grade, usually assessed formally
Constraints: con-1
Condition.stage.id 0..1 string Unique id for inter-element referencing
Condition.stage.extension 0..* Extension Additional content defined by implementations
Condition.stage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Condition.stage.summary C 0..1 CodeableConcept Simple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).
Condition.stage.assessment C 0..* Reference(ClinicalImpression | DiagnosticReport | Observation) Formal record of assessment
Condition.stage.type 0..1 CodeableConcept Kind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).
Condition.evidence C 0..* BackboneElement Supporting evidence
Constraints: con-2
Condition.evidence.id 0..1 string Unique id for inter-element referencing
Condition.evidence.extension 0..* Extension Additional content defined by implementations
Condition.evidence.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Condition.evidence.code This element is included in summaries. C 0..* CodeableConcept Manifestation/symptom
Binding: Clinical Finding (preferred)
Condition.evidence.detail This element is included in summaries. C 0..* Reference(Resource) Supporting information found elsewhere
Condition.note This element has obligations and must be supported. 0..* Annotation Additional information about the Condition
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.category Base extensible Condition Category Codes 📍4.0.1 FHIR Std.
Condition.severity Base extensible Condition/Diagnosis Severity 📦4.0.1 FHIR Std.
Condition.code Base extensible Clinical Condition ⏿1.0.2 tx.hl7.org.au
Condition.bodySite Base extensible Body Site ⏿1.0.2 tx.hl7.org.au
Condition.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Condition.stage.summary Base example Condition Stage 📍4.0.1 FHIR Std.
Condition.stage.type Base example Condition Stage Type 📍4.0.1 FHIR Std.
Condition.evidence.code Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
au-core-cond-01 error Condition.bodySite If a coded body site is provided, at least one coding shall be from SNOMED CT coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
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 AUCoreCondition

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Condition C 0..* AUCoreCondition A condition, problem or diagnosis statement in an Australian healthcare context
This profile also complies with the profile Condition (IPS)
Constraints: con-3, con-4, con-5
Condition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Condition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Condition.clinicalStatus This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConceptIPS active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.verificationStatus This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConceptIPS 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.category This element has obligations and must be supported. 1..* CodeableConceptIPS problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.severity This element has obligations and must be supported. 0..1 CodeableConceptIPS Subjective severity of condition
Binding: Condition/DiagnosisSeverity (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.code This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
Binding: Clinical Condition (extensible)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Condition.onset[x] This element has obligations and must be supported. This element is included in summaries. 0..1 Estimated or actual date, date-time, or age
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.onset[x].onsetDateTime dateTime This target must be supported.
Condition.onset[x].onsetAge Age
Condition.onset[x].onsetPeriod Period
Condition.onset[x].onsetRange Range
Condition.abatement[x] This element has obligations and must be supported. C 0..1 When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.abatement[x].abatementDateTime dateTime
Condition.abatement[x].abatementAge Age
Condition.abatement[x].abatementPeriod Period
Condition.abatement[x].abatementRange Range
Condition.note This element has obligations and must be supported. 0..* Annotation Additional information about the Condition
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco 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 extensible Condition/Diagnosis Severity 📦4.0.1 FHIR Std.
Condition.code Base extensible Clinical Condition ⏿1.0.2 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Condition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from AUCoreCondition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Condition 0..* AUCoreCondition A condition, problem or diagnosis statement in an Australian healthcare context
This profile also complies with the profile Condition (IPS)
Condition.clinicalStatus This element has obligations. 0..1 CodeableConceptIPS active | recurrence | relapse | inactive | remission | resolved
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.verificationStatus This element has obligations. 0..1 CodeableConceptIPS unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.category This element has obligations. 1..* CodeableConceptIPS problem-list-item | encounter-diagnosis
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.severity This element has obligations. 0..1 CodeableConceptIPS Subjective severity of condition
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.code This element has obligations. 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject This element has obligations. 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject.reference This element has obligations and must be supported. 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Condition.onset[x] This element has obligations. 0..1 Estimated or actual date, date-time, or age
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.onset[x].onsetDateTime dateTime
Condition.onset[x].onsetAge Age
Condition.onset[x].onsetPeriod Period
Condition.onset[x].onsetRange Range
Condition.abatement[x] This element has obligations. 0..1 dateTime, Age, Period, Range When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.note This element has obligations. 0..* Annotation Additional information about the Condition
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Condition C 0..* AUCoreCondition A condition, problem or diagnosis statement in an Australian healthcare context
This profile also complies with the profile Condition (IPS)
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.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Condition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Condition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Condition.contained 0..* Resource Contained, inline Resources
Condition.extension 0..* Extension Additional content defined by implementations
Condition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Condition.identifier This element is included in summaries. 0..* Identifier External Ids for this condition
Condition.clinicalStatus This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConceptIPS active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.verificationStatus This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. C 0..1 CodeableConceptIPS 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.category This element has obligations and must be supported. 1..* CodeableConceptIPS problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.severity This element has obligations and must be supported. 0..1 CodeableConceptIPS Subjective severity of condition
Binding: Condition/DiagnosisSeverity (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.code This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
Binding: Clinical Condition (extensible)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.bodySite This element is included in summaries. C 0..* CodeableConcept Anatomical location, if relevant
Binding: Body Site (extensible)
Constraints: au-core-cond-01
Condition.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.subject.id 0..1 string Unique id for inter-element referencing
Condition.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Condition.subject.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
Condition.subject.type This element is included in summaries. 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).
Condition.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Condition.subject.display This element is included in summaries. 0..1 string Text alternative for the resource
Condition.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
Condition.onset[x] This element has obligations and must be supported. This element is included in summaries. 0..1 Estimated or actual date, date-time, or age
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.onset[x].onsetDateTime dateTime This target must be supported.
Condition.onset[x].onsetAge Age
Condition.onset[x].onsetPeriod Period
Condition.onset[x].onsetRange Range
Condition.abatement[x] This element has obligations and must be supported. C 0..1 When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Condition.abatement[x].abatementDateTime dateTime
Condition.abatement[x].abatementAge Age
Condition.abatement[x].abatementPeriod Period
Condition.abatement[x].abatementRange Range
Condition.recordedDate This element is included in summaries. 0..1 dateTime Date record was first recorded
Condition.recorder This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the condition
Condition.asserter This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person who asserts this condition
Condition.stage C 0..* BackboneElement Stage/grade, usually assessed formally
Constraints: con-1
Condition.stage.id 0..1 string Unique id for inter-element referencing
Condition.stage.extension 0..* Extension Additional content defined by implementations
Condition.stage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Condition.stage.summary C 0..1 CodeableConcept Simple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).
Condition.stage.assessment C 0..* Reference(ClinicalImpression | DiagnosticReport | Observation) Formal record of assessment
Condition.stage.type 0..1 CodeableConcept Kind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).
Condition.evidence C 0..* BackboneElement Supporting evidence
Constraints: con-2
Condition.evidence.id 0..1 string Unique id for inter-element referencing
Condition.evidence.extension 0..* Extension Additional content defined by implementations
Condition.evidence.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Condition.evidence.code This element is included in summaries. C 0..* CodeableConcept Manifestation/symptom
Binding: Clinical Finding (preferred)
Condition.evidence.detail This element is included in summaries. C 0..* Reference(Resource) Supporting information found elsewhere
Condition.note This element has obligations and must be supported. 0..* Annotation Additional information about the Condition
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.category Base extensible Condition Category Codes 📍4.0.1 FHIR Std.
Condition.severity Base extensible Condition/Diagnosis Severity 📦4.0.1 FHIR Std.
Condition.code Base extensible Clinical Condition ⏿1.0.2 tx.hl7.org.au
Condition.bodySite Base extensible Body Site ⏿1.0.2 tx.hl7.org.au
Condition.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Condition.stage.summary Base example Condition Stage 📍4.0.1 FHIR Std.
Condition.stage.type Base example Condition Stage Type 📍4.0.1 FHIR Std.
Condition.evidence.code Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
au-core-cond-01 error Condition.bodySite If a coded body site is provided, at least one coding shall be from SNOMED CT coding.exists() implies coding.where(system='http://snomed.info/sct').exists()
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 AUCoreCondition

 

Other representations of profile: CSV, Excel, Schematron