Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions

DRAFT
ONLY

1.0 StructureDefinition-au-diagnostic-observation

AU Diagnostic Observation [FMM Level 0]

This profile defines an observation structure that includes core localisation concepts for use as a diagnostic result observation in an Australian context.

There are three preferred value sets when coding Observation.code:

The bodySite extension may be used when a coded concept does not provide the necessary detail needed for the use case.

Extensions

Extensions used in this profile:

  • Observation: bodySite (core extension) [1]

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-diagnostic-observation

This profile defines an observation structure that includes core localisation concepts for use as a diagnostic result observation in an Australian context.

This profile builds on Observation.

This profile was published on Thu Feb 13 00:00:00 AEDT 2020 as a draft by Health Level Seven Australia (Orders and Observations WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationAn observation for diagnostic reporting in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... bodySite 0..1Reference(BodyStructure)Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
... specimen 0..1Reference(AU Base Specimen)Specimen used for this observation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationAn observation for diagnostic reporting in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... bodySite I0..1Reference(BodyStructure)Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!ΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category I0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code ΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject ΣI0..1Reference(Patient | Group | Device | Location)Who and/or what the observation is about
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ΣI0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued ΣI0..1instantDate/Time this version was made available
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣI0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note I0..*AnnotationComments about the observation
... bodySite I0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... method I0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... specimen I0..1Reference(AU Base Specimen)Specimen used for this observation
... device I0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type I0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred)
.... appliesTo I0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... age I0..1RangeApplicable age range, if relevant
.... text I0..1stringText based reference range in an observation
... hasMember ΣI0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component ΣI0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
.... value[x] ΣI0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*See referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationAn observation for diagnostic reporting in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... bodySite 0..1Reference(BodyStructure)Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
... specimen 0..1Reference(AU Base Specimen)Specimen used for this observation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationAn observation for diagnostic reporting in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... bodySite I0..1Reference(BodyStructure)Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!ΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category I0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code ΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject ΣI0..1Reference(Patient | Group | Device | Location)Who and/or what the observation is about
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ΣI0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued ΣI0..1instantDate/Time this version was made available
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣI0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note I0..*AnnotationComments about the observation
... bodySite I0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... method I0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... specimen I0..1Reference(AU Base Specimen)Specimen used for this observation
... device I0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type I0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred)
.... appliesTo I0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... age I0..1RangeApplicable age range, if relevant
.... text I0..1stringText based reference range in an observation
... hasMember ΣI0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component ΣI0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
.... value[x] ΣI0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*See referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-diagnostic-observation

none defined