AU Core Implementation Guide
0.2.1-preview - Preview Australia flag

This page is part of the Australian Core IG (v0.2.1-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Condition

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition Version: 0.2.1-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreCondition

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 to record, search, and fetch problems, diagnoses, and health concerns associated with a patient. It is based on the AU Base Condition profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Condition resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for a patient’s problems, diagnoses, and health concerns
  • Record or update a patient’s problem, diagnosis, or health concern

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • 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.
  • The use of coding can vary significantly across systems, client applications need to understand that they may encounter codes they do not recognise and be prepared to handle those resources appropriately. Servers SHOULD populate Condition.code.text and/or Condition.code.coding.display so that client applications can at least display the condition even if the client application does not recognise the code supplied.
  • An active condition is represented using “active” in Condition.clinicalStatus
  • To represent that a patient does not have a condition or history of condition, an appropriate negation code is used in Condition.code
  • Refutation is not expected to be handled except as above - an appropriate negation code in Condition.code and Condition.verificationStatus of “confirmed” or “unconfirmed”

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AUBaseCondition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*AUBaseConditionA condition, problem or diagnosis statement in an Australian healthcare context
au-core-cond-05: Clinical status shall be present if verification status is not entered-in-error
... clinicalStatus SC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
... verificationStatus S0..1CodeableConceptunconfirmed | provisional | differential | confirmed | refuted | entered-in-error
... category S1..*CodeableConceptproblem-list-item | encounter-diagnosis
... code S1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (extensible)
... bodySite SC0..*CodeableConceptAnatomical location, if relevant
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT
... subject S1..1Reference(AU Core Patient)Who has the condition?
... encounter S0..1Reference(AU Core Encounter)Encounter created as part of
... onset[x] S0..1Estimated or actual date, date-time, or age
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... abatement[x] S0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
... recorder S0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Who recorded the condition
... asserter S0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Person who asserts this condition
... note S0..*AnnotationAdditional information about the Condition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Condition.severityextensibleCondition/DiagnosisSeverity
Condition.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1
Condition.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-cond-02errorCondition.bodySiteIf 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()
au-core-cond-05errorConditionClinical 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*AUBaseConditionA condition, problem or diagnosis statement in an Australian healthcare context
au-core-cond-05: Clinical status shall be present if verification status is not entered-in-error
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... clinicalStatus ?!SΣC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... category S1..*CodeableConceptproblem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... severity S0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (extensible)
... code SΣ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (extensible)
... bodySite SΣC0..*CodeableConceptAnatomical location, if relevant
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT
... subject SΣ1..1Reference(AU Core Patient)Who has the condition?
... encounter SΣ0..1Reference(AU Core Encounter)Encounter created as part of
... onset[x] SΣ0..1Estimated or actual date, date-time, or age
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... abatement[x] SC0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
... recorder SΣ0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Who recorded the condition
... asserter SΣ0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Person who asserts this condition
... note S0..*AnnotationAdditional information about the Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
Condition.verificationStatusrequiredConditionVerificationStatus
Condition.categoryextensibleConditionCategoryCodes
Condition.severityextensibleCondition/DiagnosisSeverity
Condition.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1
Condition.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-cond-02errorCondition.bodySiteIf 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()
au-core-cond-05errorConditionClinical 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*AUBaseConditionA condition, problem or diagnosis statement in an Australian healthcare context
au-core-cond-05: Clinical status shall be present if verification status is not entered-in-error
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this condition
... clinicalStatus ?!SΣC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!SΣC0..1CodeableConceptunconfirmed | 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 S1..*CodeableConceptproblem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... severity S0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (extensible)
... code SΣ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (extensible)
... bodySite SΣC0..*CodeableConceptAnatomical location, if relevant
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT
... subject SΣ1..1Reference(AU Core Patient)Who has the condition?
... encounter SΣ0..1Reference(AU Core Encounter)Encounter created as part of
... onset[x] SΣ0..1Estimated or actual date, date-time, or age
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... abatement[x] SC0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
... recordedDate Σ0..1dateTimeDate record was first recorded
... recorder SΣ0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Who recorded the condition
... asserter SΣ0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Person who asserts this condition
... stage C0..*BackboneElementStage/grade, usually assessed formally
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary C0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment C0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence C0..*BackboneElementSupporting evidence
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣC0..*CodeableConceptManifestation/symptom
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... detail ΣC0..*Reference(Resource)Supporting information found elsewhere
... note S0..*AnnotationAdditional information about the Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Condition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
Condition.verificationStatusrequiredConditionVerificationStatus
Condition.categoryextensibleConditionCategoryCodes
Condition.severityextensibleCondition/DiagnosisSeverity
Condition.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1
Condition.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Condition.stage.summaryexampleConditionStage
Condition.stage.typeexampleConditionStageType
Condition.evidence.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-cond-02errorCondition.bodySiteIf 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()

Differential View

This structure is derived from AUBaseCondition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*AUBaseConditionA condition, problem or diagnosis statement in an Australian healthcare context
au-core-cond-05: Clinical status shall be present if verification status is not entered-in-error
... clinicalStatus SC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
... verificationStatus S0..1CodeableConceptunconfirmed | provisional | differential | confirmed | refuted | entered-in-error
... category S1..*CodeableConceptproblem-list-item | encounter-diagnosis
... code S1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (extensible)
... bodySite SC0..*CodeableConceptAnatomical location, if relevant
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT
... subject S1..1Reference(AU Core Patient)Who has the condition?
... encounter S0..1Reference(AU Core Encounter)Encounter created as part of
... onset[x] S0..1Estimated or actual date, date-time, or age
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... abatement[x] S0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
... recorder S0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Who recorded the condition
... asserter S0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Person who asserts this condition
... note S0..*AnnotationAdditional information about the Condition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Condition.severityextensibleCondition/DiagnosisSeverity
Condition.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1
Condition.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-cond-02errorCondition.bodySiteIf 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()
au-core-cond-05errorConditionClinical 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*AUBaseConditionA condition, problem or diagnosis statement in an Australian healthcare context
au-core-cond-05: Clinical status shall be present if verification status is not entered-in-error
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... clinicalStatus ?!SΣC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... category S1..*CodeableConceptproblem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... severity S0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (extensible)
... code SΣ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (extensible)
... bodySite SΣC0..*CodeableConceptAnatomical location, if relevant
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT
... subject SΣ1..1Reference(AU Core Patient)Who has the condition?
... encounter SΣ0..1Reference(AU Core Encounter)Encounter created as part of
... onset[x] SΣ0..1Estimated or actual date, date-time, or age
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... abatement[x] SC0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
... recorder SΣ0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Who recorded the condition
... asserter SΣ0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Person who asserts this condition
... note S0..*AnnotationAdditional information about the Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
Condition.verificationStatusrequiredConditionVerificationStatus
Condition.categoryextensibleConditionCategoryCodes
Condition.severityextensibleCondition/DiagnosisSeverity
Condition.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1
Condition.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-cond-02errorCondition.bodySiteIf 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()
au-core-cond-05errorConditionClinical 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*AUBaseConditionA condition, problem or diagnosis statement in an Australian healthcare context
au-core-cond-05: Clinical status shall be present if verification status is not entered-in-error
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this condition
... clinicalStatus ?!SΣC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!SΣC0..1CodeableConceptunconfirmed | 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 S1..*CodeableConceptproblem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... severity S0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (extensible)
... code SΣ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 (extensible)
... bodySite SΣC0..*CodeableConceptAnatomical location, if relevant
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible)
au-core-cond-02: If a coded body site is provided, at least one code shall be from SNOMED CT
... subject SΣ1..1Reference(AU Core Patient)Who has the condition?
... encounter SΣ0..1Reference(AU Core Encounter)Encounter created as part of
... onset[x] SΣ0..1Estimated or actual date, date-time, or age
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... abatement[x] SC0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
... recordedDate Σ0..1dateTimeDate record was first recorded
... recorder SΣ0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Who recorded the condition
... asserter SΣ0..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson)Person who asserts this condition
... stage C0..*BackboneElementStage/grade, usually assessed formally
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary C0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment C0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence C0..*BackboneElementSupporting evidence
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣC0..*CodeableConceptManifestation/symptom
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... detail ΣC0..*Reference(Resource)Supporting information found elsewhere
... note S0..*AnnotationAdditional information about the Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Condition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
Condition.verificationStatusrequiredConditionVerificationStatus
Condition.categoryextensibleConditionCategoryCodes
Condition.severityextensibleCondition/DiagnosisSeverity
Condition.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1
Condition.bodySiteextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Condition.stage.summaryexampleConditionStage
Condition.stage.typeexampleConditionStageType
Condition.evidence.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-cond-02errorCondition.bodySiteIf 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()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
patient SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
patient+category SHALL reference+token
patient+clinical-status SHALL reference+token
patient+category+clinical-status SHOULD reference+token+token
patient+code SHOULD reference+token
patient.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both.

The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
patient+onset-date SHOULD reference+date
category MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
clinical-status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
code MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
onset-date MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using the patient search parameter:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Condition?patient={Type/}[id] or optionally GET [base]/Condition?patient.identifier=[system|][code]

    Example:

    1. GET [base]/Condition?patient=5678
    2. GET [base]/Condition?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    3. GET [base]/Condition?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

    Implementation Notes: Fetches a bundle of all Condition resources for the specified patient (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and category search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Condition?patient={Type/}[id]&category={system|}[code]

    Example:

    1. GET [base]/Condition?patient=5678&category=http://terminology.hl7.org/CodeSystem/condition-category|encounter-diagnosis

    Implementation Notes: Fetches a bundle of all Condition resources for the specified patient and category code = encounter-diagnosis (how to search by reference and how to search by token)

  3. SHALL support searching using the combination of the patient and clinical-status search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Condition?patient={Type/}[id]&clinical-status={system|}[code]

    Example:

    1. GET [base]/Condition?patient=5678&clinical-status=http://terminology.hl7.org/CodeSystem/observation-clinical-status|encounter-diagnosis

    Implementation Notes: Fetches a bundle of all Condition resources for the specified patient and a clinical status. (how to search by reference and how to search by token)

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and category and clinical-status search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Condition?patient={Type/}[id]&category={system|}[code]&clinical-status={system|}[code]

    Example:

    1. GET [base]/Condition?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|encounter-diagnosis&clinical-status=http://terminology.hl7.org/CodeSystem/condition-clinical active

    Implementation Notes: Fetches a bundle of all Condition resources for the specified patient and category and clinical-status (how to search by reference and how to search by token)

  2. SHOULD support searching using the combination of the patient and code search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/Condition?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Condition?patient=5678&code=http://snomed.info/sct|68566005,http://snomed.info/sct|394659003

    Implementation Notes: Fetches a bundle of all Condition resources for the specified patient and condition code(s). SHOULD support search by multiple codes. The Condition code parameter searches `Condition.code only. (how to search by reference and how to search by token)

    1. SHOULD support searching using the combination of the patient and onset-date search parameters:
      • SHALL support these _revinclude parameters: Provenance:target
      • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
      • SHALL support these onset-date comparators: gt,lt,ge,le
      • SHOULD support multipleAnd search on onset-date (e.g.onset-date=[date]&date=[date]]&...)

    GET [base]/Condition?patient={Type/}[id]&onset-date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Condition?patient=5678&onset-date=ge2020-01-01T00:00:00Z
    2. GET [base]/Condition?patient.identifier=http://example.org/fhir/mrn|12345&onset-date=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all Condition resources for the specified patient and onset-date. (how to search by reference and how to search by date)