Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-condition-core-1 | Version: 1.0.1 | |||
Active as of 2024-09-12 | Computable Name: ADHAConditionCore | |||
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
The purpose of this profile is to provide a core representation of a condition for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. This profile supports a statement of a condition, problem, or diagnosis including asserting negation for specific conditions or problems.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Condition that are supported.
This profile is designed to set a core Condition standard for:
This profile may be referred to by APIs, which will be listed here when available.
Condition.category
provides an efficient way of supporting system interactions, e.g. restricting searches. Implementers need to understand that data categorisation is somewhat subjective. The categorisation applied by the source may not align with a receiver’s expectations.Condition.clinicalStatus
.Condition.code
.Condition.code
and Condition.verificationStatus
of "confirmed" or "unconfirmed".Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseCondition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | C | 0..* | AUBaseCondition | A condition, problem or diagnosis statement in an Australian healthcare context inv-dh-cond-01: If present, an asserter shall at least have a reference, an identifier or a display inv-dh-cond-05: Clinical status shall be present if verification status is not entered-in-error |
clinicalStatus | SC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved |
verificationStatus | S | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error |
category | S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis |
severity | S | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible) |
code | S | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Clinical Condition (extensible) |
bodySite | SC | 0..* | CodeableConcept | Anatomical location, if relevant Binding: Body Site (extensible) inv-dh-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Who has the condition? inv-dh-cond-03: At least reference or a valid identifier shall be present |
encounter | S | 0..1 | Reference(ADHA Core Encounter) | Encounter created as part of |
onset[x] | S | 0..1 | Estimated or actual date, date-time, or age | |
onsetDateTime | dateTime | |||
onsetAge | Age | |||
onsetPeriod | Period | |||
onsetRange | Range | |||
abatement[x] | S | 0..1 | When in resolution/remission | |
abatementDateTime | dateTime | |||
abatementAge | Age | |||
abatementPeriod | Period | |||
abatementRange | Range | |||
recorder | SC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson) | Who recorded the condition inv-dh-cond-04: At least reference or display or a valid identifier shall be present |
asserter | SC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Patient | ADHA Core RelatedPerson) | Person who asserts this condition |
note | S | 0..* | Annotation | Additional information about the Condition |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.severity | extensible | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
Condition.code | extensible | ClinicalCondition https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 | |
Condition.bodySite | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cond-01 | error | Condition | If present, an asserter shall at least have a reference, an identifier or a display : asserter.exists() implies asserter.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-cond-02 | error | Condition.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
inv-dh-cond-03 | error | Condition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-04 | error | Condition.recorder | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-05 | error | Condition | Clinical status shall be present if verification status is not entered-in-error : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | C | 0..* | AUBaseCondition | A condition, problem or diagnosis statement in an Australian healthcare context con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error inv-dh-cond-01: If present, an asserter shall at least have a reference, an identifier or a display inv-dh-cond-05: Clinical status shall be present if verification status is not entered-in-error |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. |
verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. |
category | S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. |
severity | S | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible) |
code | SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Clinical Condition (extensible) |
bodySite | SΣC | 0..* | CodeableConcept | Anatomical location, if relevant Binding: Body Site (extensible) inv-dh-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT |
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who has the condition? inv-dh-cond-03: At least reference or a valid identifier shall be present |
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Encounter created as part of |
onset[x] | SΣ | 0..1 | Estimated or actual date, date-time, or age | |
onsetDateTime | dateTime | |||
onsetAge | Age | |||
onsetPeriod | Period | |||
onsetRange | Range | |||
abatement[x] | SC | 0..1 | When in resolution/remission | |
abatementDateTime | dateTime | |||
abatementAge | Age | |||
abatementPeriod | Period | |||
abatementRange | Range | |||
recorder | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson) | Who recorded the condition inv-dh-cond-04: At least reference or display or a valid identifier shall be present |
asserter | SΣC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Patient | ADHA Core RelatedPerson) | Person who asserts this condition |
note | S | 0..* | Annotation | Additional information about the Condition |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard | |
Condition.category | extensible | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | |
Condition.severity | extensible | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
Condition.code | extensible | ClinicalCondition https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 | |
Condition.bodySite | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cond-01 | error | Condition | If present, an asserter shall at least have a reference, an identifier or a display : asserter.exists() implies asserter.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-cond-02 | error | Condition.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
inv-dh-cond-03 | error | Condition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-04 | error | Condition.recorder | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-05 | error | Condition | Clinical status shall be present if verification status is not entered-in-error : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | AUBaseCondition | A condition, problem or diagnosis statement in an Australian healthcare context con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error inv-dh-cond-01: If present, an asserter shall at least have a reference, an identifier or a display inv-dh-cond-05: Clinical status shall be present if verification status is not entered-in-error | ||||
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 | |||||
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 | ?!SΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. | ||||
category | S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | ||||
severity | S | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible) | ||||
code | SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Clinical Condition (extensible) | ||||
bodySite | SΣC | 0..* | CodeableConcept | Anatomical location, if relevant Binding: Body Site (extensible) inv-dh-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who has the condition? inv-dh-cond-03: At least reference or a valid identifier shall be present | ||||
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Encounter created as part of | ||||
onset[x] | SΣ | 0..1 | Estimated or actual date, date-time, or age | |||||
onsetDateTime | dateTime | |||||||
onsetAge | Age | |||||||
onsetPeriod | Period | |||||||
onsetRange | Range | |||||||
abatement[x] | SC | 0..1 | When in resolution/remission | |||||
abatementDateTime | dateTime | |||||||
abatementAge | Age | |||||||
abatementPeriod | Period | |||||||
abatementRange | Range | |||||||
recordedDate | Σ | 0..1 | dateTime | Date record was first recorded | ||||
recorder | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson) | Who recorded the condition inv-dh-cond-04: At least reference or display or a valid identifier shall be present | ||||
asserter | SΣC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Patient | ADHA Core RelatedPerson) | Person who asserts this condition | ||||
stage | C | 0..* | BackboneElement | Stage/grade, usually assessed formally con-1: Stage SHALL have summary or assessment | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
summary | C | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
assessment | C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||
type | 0..1 | CodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||
evidence | C | 0..* | BackboneElement | Supporting evidence con-2: evidence SHALL have code or details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | ΣC | 0..* | CodeableConcept | Manifestation/symptom Binding: Clinical Finding (preferred) | ||||
detail | ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||
note | S | 0..* | Annotation | Additional information about the Condition | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard | ||||
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard | ||||
Condition.category | extensible | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | ||||
Condition.severity | extensible | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | ||||
Condition.code | extensible | ClinicalCondition https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 | ||||
Condition.bodySite | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard | ||||
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | ||||
Condition.evidence.code | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cond-01 | error | Condition | If present, an asserter shall at least have a reference, an identifier or a display : asserter.exists() implies asserter.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-cond-02 | error | Condition.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
inv-dh-cond-03 | error | Condition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-04 | error | Condition.recorder | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-05 | error | Condition | Clinical status shall be present if verification status is not entered-in-error : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() |
This structure is derived from AUBaseCondition
Summary
Mandatory: 3 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from AUBaseCondition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | C | 0..* | AUBaseCondition | A condition, problem or diagnosis statement in an Australian healthcare context inv-dh-cond-01: If present, an asserter shall at least have a reference, an identifier or a display inv-dh-cond-05: Clinical status shall be present if verification status is not entered-in-error |
clinicalStatus | SC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved |
verificationStatus | S | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error |
category | S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis |
severity | S | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible) |
code | S | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Clinical Condition (extensible) |
bodySite | SC | 0..* | CodeableConcept | Anatomical location, if relevant Binding: Body Site (extensible) inv-dh-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Who has the condition? inv-dh-cond-03: At least reference or a valid identifier shall be present |
encounter | S | 0..1 | Reference(ADHA Core Encounter) | Encounter created as part of |
onset[x] | S | 0..1 | Estimated or actual date, date-time, or age | |
onsetDateTime | dateTime | |||
onsetAge | Age | |||
onsetPeriod | Period | |||
onsetRange | Range | |||
abatement[x] | S | 0..1 | When in resolution/remission | |
abatementDateTime | dateTime | |||
abatementAge | Age | |||
abatementPeriod | Period | |||
abatementRange | Range | |||
recorder | SC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson) | Who recorded the condition inv-dh-cond-04: At least reference or display or a valid identifier shall be present |
asserter | SC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Patient | ADHA Core RelatedPerson) | Person who asserts this condition |
note | S | 0..* | Annotation | Additional information about the Condition |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.severity | extensible | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
Condition.code | extensible | ClinicalCondition https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 | |
Condition.bodySite | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cond-01 | error | Condition | If present, an asserter shall at least have a reference, an identifier or a display : asserter.exists() implies asserter.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-cond-02 | error | Condition.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
inv-dh-cond-03 | error | Condition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-04 | error | Condition.recorder | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-05 | error | Condition | Clinical status shall be present if verification status is not entered-in-error : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | C | 0..* | AUBaseCondition | A condition, problem or diagnosis statement in an Australian healthcare context con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error inv-dh-cond-01: If present, an asserter shall at least have a reference, an identifier or a display inv-dh-cond-05: Clinical status shall be present if verification status is not entered-in-error |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. |
verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. |
category | S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. |
severity | S | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible) |
code | SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Clinical Condition (extensible) |
bodySite | SΣC | 0..* | CodeableConcept | Anatomical location, if relevant Binding: Body Site (extensible) inv-dh-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT |
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who has the condition? inv-dh-cond-03: At least reference or a valid identifier shall be present |
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Encounter created as part of |
onset[x] | SΣ | 0..1 | Estimated or actual date, date-time, or age | |
onsetDateTime | dateTime | |||
onsetAge | Age | |||
onsetPeriod | Period | |||
onsetRange | Range | |||
abatement[x] | SC | 0..1 | When in resolution/remission | |
abatementDateTime | dateTime | |||
abatementAge | Age | |||
abatementPeriod | Period | |||
abatementRange | Range | |||
recorder | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson) | Who recorded the condition inv-dh-cond-04: At least reference or display or a valid identifier shall be present |
asserter | SΣC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Patient | ADHA Core RelatedPerson) | Person who asserts this condition |
note | S | 0..* | Annotation | Additional information about the Condition |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard | |
Condition.category | extensible | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | |
Condition.severity | extensible | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
Condition.code | extensible | ClinicalCondition https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 | |
Condition.bodySite | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cond-01 | error | Condition | If present, an asserter shall at least have a reference, an identifier or a display : asserter.exists() implies asserter.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-cond-02 | error | Condition.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
inv-dh-cond-03 | error | Condition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-04 | error | Condition.recorder | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-05 | error | Condition | Clinical status shall be present if verification status is not entered-in-error : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | AUBaseCondition | A condition, problem or diagnosis statement in an Australian healthcare context con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error inv-dh-cond-01: If present, an asserter shall at least have a reference, an identifier or a display inv-dh-cond-05: Clinical status shall be present if verification status is not entered-in-error | ||||
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 | |||||
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 | ?!SΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. | ||||
category | S | 1..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: ConditionCategoryCodes (extensible): A category assigned to the condition. | ||||
severity | S | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (extensible) | ||||
code | SΣ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Clinical Condition (extensible) | ||||
bodySite | SΣC | 0..* | CodeableConcept | Anatomical location, if relevant Binding: Body Site (extensible) inv-dh-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who has the condition? inv-dh-cond-03: At least reference or a valid identifier shall be present | ||||
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Encounter created as part of | ||||
onset[x] | SΣ | 0..1 | Estimated or actual date, date-time, or age | |||||
onsetDateTime | dateTime | |||||||
onsetAge | Age | |||||||
onsetPeriod | Period | |||||||
onsetRange | Range | |||||||
abatement[x] | SC | 0..1 | When in resolution/remission | |||||
abatementDateTime | dateTime | |||||||
abatementAge | Age | |||||||
abatementPeriod | Period | |||||||
abatementRange | Range | |||||||
recordedDate | Σ | 0..1 | dateTime | Date record was first recorded | ||||
recorder | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson) | Who recorded the condition inv-dh-cond-04: At least reference or display or a valid identifier shall be present | ||||
asserter | SΣC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Patient | ADHA Core RelatedPerson) | Person who asserts this condition | ||||
stage | C | 0..* | BackboneElement | Stage/grade, usually assessed formally con-1: Stage SHALL have summary or assessment | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
summary | C | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
assessment | C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||
type | 0..1 | CodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||
evidence | C | 0..* | BackboneElement | Supporting evidence con-2: evidence SHALL have code or details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | ΣC | 0..* | CodeableConcept | Manifestation/symptom Binding: Clinical Finding (preferred) | ||||
detail | ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||
note | S | 0..* | Annotation | Additional information about the Condition | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard | ||||
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard | ||||
Condition.category | extensible | ConditionCategoryCodeshttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | ||||
Condition.severity | extensible | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | ||||
Condition.code | extensible | ClinicalCondition https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 | ||||
Condition.bodySite | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard | ||||
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | ||||
Condition.evidence.code | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cond-01 | error | Condition | If present, an asserter shall at least have a reference, an identifier or a display : asserter.exists() implies asserter.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-cond-02 | error | Condition.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
inv-dh-cond-03 | error | Condition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-04 | error | Condition.recorder | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cond-05 | error | Condition | Clinical status shall be present if verification status is not entered-in-error : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() |
This structure is derived from AUBaseCondition
Summary
Mandatory: 3 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Name | Type | Conformance | Description | Path |
---|---|---|---|---|
category | token | SHALL | The category of the condition | Condition.category |
subject:identifier | token | SHALL | Who has the condition? | Condition.subject.identifier |
code | token | SHALL | Code for the condition | Condition.code |
clinical-status | token | SHALL | The clinical status of the condition | Condition.clinicalStatus |
onset-date | token | SHOULD | Date related onsets (dateTime and Period) | Condition.onset.as(dateTime) | Condition.onset.as(Period) |
abatement-date | token | SHOULD | Date-related abatements (dateTime and period) | Condition.abatement.as(dateTime) | Condition.abatement.as(Period) |
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching for all conditions for a patient using the subject:identifier
search parameter:
GET [base]/Condition?subject:identifier={system|}[code]
Example:
GET [base]/Condition?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437
Implementation Notes: Fetches a bundle of all Condition resources for the specified patient (how to search by :identifier)
SHALL support searching using the combination subject:identifier
and category
search parameter:
GET [base]/Condition?subject:identifier={system|}[code]&category={system|}[code]
Example:
GET [base]/Condition?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item
Implementation Notes: Fetches a bundle of all Condition resources with the category of "Problem List Item" for the specified patient (how to search by :identifier)
SHALL support searching using the combination subject:identifier
and code
search parameter:
GET [base]/Condition?subject:identifier={system|}[code]&code={system|}[code]
Example:
GET [base]/Condition?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&code=http://snomed.info/sct|68566005
Implementation Notes: Fetches a bundle of all Condition resources with the code of an 68566005 (Urinary tract infection) for the specified patient (how to search by :identifier and how to search by token)
SHALL support searching using the combination subject:identifier
and clinical-status
search parameter:
GET [base]/Condition?subject:identifier={system|}[code]&clinical-status={system|}[code]
Example:
GET [base]/Condition?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&clinical-status=http://terminology.hl7.org/CodeSystem/condition-clinical|active
Implementation Notes: Fetches a bundle of all Condition resources for the specified patient and status code. This will not return any "entered in error" resources because of the conditional presence of the clinicalStatus element. (how to search by :identifier and how to search by token)