AU Patient Summary Implementation Guide
0.5.0-cibuild - CI Build
AU Patient Summary Implementation Guide
0.5.0-cibuild - CI Build
AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.5.0-cibuild 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
| Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-condition | Version: 0.5.0-cibuild | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSCondition | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; 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.
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 profile view. See Zulip discussion for more information.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCoreCondition
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Condition |
0..* | AUCoreCondition | A condition, problem or diagnosis statement in an Australian healthcare context This profile also complies with the profile Condition (IPS) | |||||||||
  clinicalStatus |
O | 0..1 | CodeableConceptIPS | active | recurrence | relapse | inactive | remission | resolved
| ||||||||
| verificationStatus |
O | 0..1 | CodeableConceptIPS | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
| ||||||||
| category |
O | 1..* | CodeableConceptIPS | problem-list-item | encounter-diagnosis
| ||||||||
| severity |
O | 0..1 | CodeableConceptIPS | Subjective severity of condition
| ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Identification of the condition, problem or diagnosis
| ||||||||
  subject |
O | 1..1 | Reference(AU PS Patient) | Who has the condition?
| ||||||||
   reference |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
 onset[x] |
O | 0..1 | Estimated or actual date, date-time, or age
| |||||||||
 onsetDateTime |
dateTime | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| abatement[x] |
O | 0..1 | dateTime, Age, Period, Range | When in resolution/remission
| ||||||||
| note |
O | 0..* | Annotation | Additional information about the Condition
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
| ||||||||
| verificationStatus |
?!SOΣ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.
| ||||||||
| category |
SO | 1..* | CodeableConceptIPS | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
| ||||||||
| severity |
SO | 0..1 | CodeableConceptIPS | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible)
| ||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Identification of the condition, problem or diagnosis Binding: Clinical Condition  (extensible)
| ||||||||
| subject |
SOΣ | 1..1 | Reference(AU PS Patient) | Who has the condition?
| ||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| onset[x] |
SOΣ | 0..1 | Estimated or actual date, date-time, or age
| |||||||||
| onsetDateTime |
dateTime S | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| abatement[x] |
SOC | 0..1 | When in resolution/remission
| |||||||||
| abatementDateTime |
dateTime | |||||||||||
| abatementAge |
Age | |||||||||||
| abatementPeriod |
Period | |||||||||||
| abatementRange |
Range | |||||||||||
| note |
SO | 0..* | Annotation | Additional information about the Condition
| ||||||||
| Documentation for this format | ||||||||||||
| 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.ontoserver.csiro.au |
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | ||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| 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.
| |||||||||
| 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 | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | External Ids for this condition | ||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
| ||||||||
| verificationStatus |
?!SOΣ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.
| ||||||||
| category |
SO | 1..* | CodeableConceptIPS | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
| ||||||||
| severity |
SO | 0..1 | CodeableConceptIPS | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible)
| ||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Identification of the condition, problem or diagnosis Binding: Clinical Condition (extensible)
| ||||||||
| bodySite |
ΣC | 0..* | CodeableConcept | Anatomical location, if relevant Binding: Body Site (extensible)Constraints: au-core-cond-01 | ||||||||
| subject |
SOΣ | 1..1 | Reference(AU PS 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 |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| 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 | ||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||||||
| onset[x] |
SOΣ | 0..1 | Estimated or actual date, date-time, or age
| |||||||||
| onsetDateTime |
dateTime S | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| abatement[x] |
SOC | 0..1 | When in resolution/remission
| |||||||||
| abatementDateTime |
dateTime | |||||||||||
| abatementAge |
Age | |||||||||||
| abatementPeriod |
Period | |||||||||||
| abatementRange |
Range | |||||||||||
| recordedDate |
Σ | 0..1 | dateTime | Date record was first recorded | ||||||||
| recorder |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the condition | ||||||||
| asserter |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Person who asserts this condition | ||||||||
| stage |
C | 0..* | BackboneElement | Stage/grade, usually assessed formally Constraints: con-1 | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| summary |
C | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||||||
| assessment |
C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||||||
| type |
0..1 | CodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||||||
| evidence |
C | 0..* | BackboneElement | Supporting evidence Constraints: con-2 | ||||||||
| 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: Clinical Finding (preferred) | ||||||||
| detail |
ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||||||
| note |
SO | 0..* | Annotation | Additional information about the Condition
| ||||||||
| Documentation for this format | ||||||||||||
| 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.ontoserver.csiro.au |
| Condition.bodySite | Base | extensible |
Body Site
|
⏿1.0.2 | tx.ontoserver.csiro.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.ontoserver.csiro.au |
| 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
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUCoreCondition
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Condition |
0..* | AUCoreCondition | A condition, problem or diagnosis statement in an Australian healthcare context This profile also complies with the profile Condition (IPS) | |||||||||
| clinicalStatus |
O | 0..1 | CodeableConceptIPS | active | recurrence | relapse | inactive | remission | resolved
| ||||||||
| verificationStatus |
O | 0..1 | CodeableConceptIPS | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
| ||||||||
| category |
O | 1..* | CodeableConceptIPS | problem-list-item | encounter-diagnosis
| ||||||||
| severity |
O | 0..1 | CodeableConceptIPS | Subjective severity of condition
| ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Identification of the condition, problem or diagnosis
| ||||||||
| subject |
O | 1..1 | Reference(AU PS Patient) | Who has the condition?
| ||||||||
| reference |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| onset[x] |
O | 0..1 | Estimated or actual date, date-time, or age
| |||||||||
| onsetDateTime |
dateTime | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| abatement[x] |
O | 0..1 | dateTime, Age, Period, Range | When in resolution/remission
| ||||||||
| note |
O | 0..* | Annotation | Additional information about the Condition
| ||||||||
| Documentation for this format | ||||||||||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
| ||||||||
| verificationStatus |
?!SOΣ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.
| ||||||||
| category |
SO | 1..* | CodeableConceptIPS | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
| ||||||||
| severity |
SO | 0..1 | CodeableConceptIPS | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible)
| ||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Identification of the condition, problem or diagnosis Binding: Clinical Condition (extensible)
| ||||||||
| subject |
SOΣ | 1..1 | Reference(AU PS Patient) | Who has the condition?
| ||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| onset[x] |
SOΣ | 0..1 | Estimated or actual date, date-time, or age
| |||||||||
| onsetDateTime |
dateTime S | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| abatement[x] |
SOC | 0..1 | When in resolution/remission
| |||||||||
| abatementDateTime |
dateTime | |||||||||||
| abatementAge |
Age | |||||||||||
| abatementPeriod |
Period | |||||||||||
| abatementRange |
Range | |||||||||||
| note |
SO | 0..* | Annotation | Additional information about the Condition
| ||||||||
| Documentation for this format | ||||||||||||
| 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.ontoserver.csiro.au |
| 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()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | ||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| 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.
| |||||||||
| 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 | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | External Ids for this condition | ||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
| ||||||||
| verificationStatus |
?!SOΣ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.
| ||||||||
| category |
SO | 1..* | CodeableConceptIPS | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
| ||||||||
| severity |
SO | 0..1 | CodeableConceptIPS | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible)
| ||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Identification of the condition, problem or diagnosis Binding: Clinical Condition (extensible)
| ||||||||
| bodySite |
ΣC | 0..* | CodeableConcept | Anatomical location, if relevant Binding: Body Site (extensible)Constraints: au-core-cond-01 | ||||||||
| subject |
SOΣ | 1..1 | Reference(AU PS 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 |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| 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 | ||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||||||
| onset[x] |
SOΣ | 0..1 | Estimated or actual date, date-time, or age
| |||||||||
| onsetDateTime |
dateTime S | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| abatement[x] |
SOC | 0..1 | When in resolution/remission
| |||||||||
| abatementDateTime |
dateTime | |||||||||||
| abatementAge |
Age | |||||||||||
| abatementPeriod |
Period | |||||||||||
| abatementRange |
Range | |||||||||||
| recordedDate |
Σ | 0..1 | dateTime | Date record was first recorded | ||||||||
| recorder |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the condition | ||||||||
| asserter |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Person who asserts this condition | ||||||||
| stage |
C | 0..* | BackboneElement | Stage/grade, usually assessed formally Constraints: con-1 | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| summary |
C | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||||||
| assessment |
C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||||||
| type |
0..1 | CodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||||||
| evidence |
C | 0..* | BackboneElement | Supporting evidence Constraints: con-2 | ||||||||
| 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: Clinical Finding (preferred) | ||||||||
| detail |
ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||||||
| note |
SO | 0..* | Annotation | Additional information about the Condition
| ||||||||
| Documentation for this format | ||||||||||||
| 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.ontoserver.csiro.au |
| Condition.bodySite | Base | extensible |
Body Site
|
⏿1.0.2 | tx.ontoserver.csiro.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.ontoserver.csiro.au |
| 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
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Australia. Package hl7.fhir.au.ps#0.5.0-cibuild based on FHIR 4.0.1. Generated 2025-10-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change