AU Patient Summary Implementation Guide
0.5.0-cibuild - 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 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

Resource Profile: AU PS Condition

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.

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 profile view. See Zulip discussion for more information.

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.

This structure is derived from AUCoreCondition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... verificationStatus O 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
... category O 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
... code O 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... subject O 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... reference SO 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
... onset[x] O 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
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
... abatement[x] O 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
... note O 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: Filtersdoco
.. 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... category SO 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
... severity SO 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
... code SOΣ 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
Binding: Clinical Condition . (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... subject SOΣ 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
... onset[x] SOΣ 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
.... onsetDateTime dateTime S
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
... abatement[x] SOC 0..1 When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
... note SO 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

PathConformanceValueSetURI
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
From the FHIR Standard
Condition.verificationStatusrequiredConditionVerificationStatus
http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1
From the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
From the FHIR Standard
Condition.severityextensibleCondition/DiagnosisSeverity
http://hl7.org/fhir/ValueSet/condition-severity
From the FHIR Standard
Condition.codeextensibleClinicalCondition .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1

Constraints

IdGradePath(s)DetailsRequirements
con-3best practiceConditionCondition.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-4errorConditionIf 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-5errorConditionCondition.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-2errorConditionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConditionIf 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-4errorConditionIf 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-5errorConditionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConditionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... category SO 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
... severity SO 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
... code SOΣ 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
Binding: Clinical Condition . (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
.... 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
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... onsetDateTime dateTime S
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
... abatement[x] SOC 0..1 When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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
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

PathConformanceValueSetURI
Condition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
From the FHIR Standard
Condition.verificationStatusrequiredConditionVerificationStatus
http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1
From the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
From the FHIR Standard
Condition.severityextensibleCondition/DiagnosisSeverity
http://hl7.org/fhir/ValueSet/condition-severity
From the FHIR Standard
Condition.codeextensibleClinicalCondition .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1
Condition.bodySiteextensibleBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Condition.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Condition.stage.summaryexampleConditionStage
http://hl7.org/fhir/ValueSet/condition-stage
From the FHIR Standard
Condition.stage.typeexampleConditionStageType
http://hl7.org/fhir/ValueSet/condition-stage-type
From the FHIR Standard
Condition.evidence.codepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-cond-01errorCondition.bodySiteIf 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-1errorCondition.stageStage SHALL have summary or assessment
: summary.exists() or assessment.exists()
con-2errorCondition.evidenceevidence SHALL have code or details
: code.exists() or detail.exists()
con-3best practiceConditionCondition.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-4errorConditionIf 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-5errorConditionCondition.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-2errorConditionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConditionIf 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-4errorConditionIf 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-5errorConditionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConditionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUCoreCondition

Differential View

This structure is derived from AUCoreCondition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... verificationStatus O 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
... category O 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
... code O 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... subject O 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... reference SO 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
... onset[x] O 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
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
... abatement[x] O 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
... note O 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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... category SO 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
... severity SO 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
... code SOΣ 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
Binding: Clinical Condition . (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... subject SOΣ 1..1 Reference(AU PS Patient) Who has the condition?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
... onset[x] SOΣ 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
.... onsetDateTime dateTime S
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
... abatement[x] SOC 0..1 When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
... note SO 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

PathConformanceValueSetURI
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
From the FHIR Standard
Condition.verificationStatusrequiredConditionVerificationStatus
http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1
From the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
From the FHIR Standard
Condition.severityextensibleCondition/DiagnosisSeverity
http://hl7.org/fhir/ValueSet/condition-severity
From the FHIR Standard
Condition.codeextensibleClinicalCondition .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1

Constraints

IdGradePath(s)DetailsRequirements
con-3best practiceConditionCondition.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-4errorConditionIf 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-5errorConditionCondition.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-2errorConditionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConditionIf 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-4errorConditionIf 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-5errorConditionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConditionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... category SO 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
... severity SO 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
... code SOΣ 1..1 CodeableConceptIPS Identification of the condition, problem or diagnosis
Binding: Clinical Condition . (extensible)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... 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?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
.... 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
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... onsetDateTime dateTime S
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
... abatement[x] SOC 0..1 When in resolution/remission
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... 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
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

PathConformanceValueSetURI
Condition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
From the FHIR Standard
Condition.verificationStatusrequiredConditionVerificationStatus
http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1
From the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
From the FHIR Standard
Condition.severityextensibleCondition/DiagnosisSeverity
http://hl7.org/fhir/ValueSet/condition-severity
From the FHIR Standard
Condition.codeextensibleClinicalCondition .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1
Condition.bodySiteextensibleBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Condition.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Condition.stage.summaryexampleConditionStage
http://hl7.org/fhir/ValueSet/condition-stage
From the FHIR Standard
Condition.stage.typeexampleConditionStageType
http://hl7.org/fhir/ValueSet/condition-stage-type
From the FHIR Standard
Condition.evidence.codepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-cond-01errorCondition.bodySiteIf 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-1errorCondition.stageStage SHALL have summary or assessment
: summary.exists() or assessment.exists()
con-2errorCondition.evidenceevidence SHALL have code or details
: code.exists() or detail.exists()
con-3best practiceConditionCondition.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-4errorConditionIf 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-5errorConditionCondition.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-2errorConditionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConditionIf 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-4errorConditionIf 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-5errorConditionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConditionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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