AU Base Implementation Guide
6.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base Diagnostic Imaging Result

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-imagingresult Version: 6.0.0-ci-build
Standards status: Trial-use Maturity Level: 1 Computable Name: AUBaseDiagnosticImagingResult

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines an observation structure to represent a imaging examination result issued by a diagnostic service provider in an Australian context. The observation may represent the conclusions of a diagnostic procedure such as Left retina Foveal thickness by OCT, or it may group the set of results produced by a multi-test study or panel such as Biophysical profile panel.

Usage Notes

Profile specific implementation guidance:

  • The BodyStructure Reference extension may be suitable for use where
    • body site is not implicit in the code found in Observation.code and
    • body site information cannot be adequately captured by a single inline coded element in Observation.bodySite.
  • When sending an observation that represents a study series or panel:
    • the group / panel code is sent in Observation.code
    • the overall comments are sent in Observation.note
    • the global interpretation by the producer of the study is sent in Observation.interpretation
    • individual results may be sent in Observation.component or by referencing individual observation results in Observation.hasMember
  • When sending observations that group the set of results of a multi-modality procedure:
    • A multi-modality procedure observation is sent with individual component examinations in Observation.hasMember.
    • An individual component examination observation is referenced by that multi-modality procedure observation (Observation.hasMember) rather than directly at the diagnostic report level (DiagnosticReport.result).

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 5.0.0:

  • The data elements list has changed

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 0..* Observation A imaging examination result in an Australian healthcare context
    Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... Slices for category 1..* CodeableConcept Relevant diagnostic imaging category: service, modality and anatomic region
    Slice: Unordered, Open by value:coding.system, value:coding.code
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    .... category:diagImg 1..1 CodeableConcept Observation generated by imaging
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    ..... coding Σ 1..* Coding Code defined by a terminology system
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
    ...... code Σ 1..1 code Symbol in syntax defined by the system
    Fixed Value: imaging
    .... category:anatomicRegionOfInterest 0..* CodeableConcept Anatomic Region Of Interest
    Binding: Imaging Anatomic Region Of Interest . (extensible)
    ... code Σ 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    ... subject Σ 1..1 Reference(Patient) Who and/or what the observation is about
    ... effective[x] Σ 1..1 Time of diagnostic imaging examination
    .... effectiveDateTime dateTime
    .... effectivePeriod Period
    .... effectiveTiming Timing
    .... effectiveInstant instant
    ... value[x] ΣC 0..1 Actual result
    .... valueQuantity Quantity
    .... valueCodeableConcept CodeableConcept
    .... valueString string
    .... valueBoolean boolean
    .... valueInteger integer
    .... valueRange Range
    .... valueRatio Ratio
    .... valueSampledData SampledData
    .... valueTime time
    .... valueDateTime dateTime
    .... valuePeriod Period
    ... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    ... bodySite C 0..1 CodeableConcept Observed body part
    Binding: Body Site . (preferred)
    ... hasMember ΣC 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result) Individual examinations in a group or study series
    ... component Σ 0..* BackboneElement Individual examinations in a group or study series
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... code Σ 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    .... value[x] ΣC 0..1 Actual component result
    ..... valueQuantity Quantity
    ..... valueCodeableConcept CodeableConcept
    ..... valueString string
    ..... valueBoolean boolean
    ..... valueInteger integer
    ..... valueRange Range
    ..... valueRatio Ratio
    ..... valueSampledData SampledData
    ..... valueTime time
    ..... valueDateTime dateTime
    ..... valuePeriod Period
    .... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:diagImg Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:anatomicRegionOfInterest Base extensible Imaging Anatomic Region Of Interest . ⏿1.0.0 tx.ontoserver.csiro.au
    Observation.code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.bodySite Base preferred Body Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.component.​code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-obs-0 error Observation An imaging result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
    obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 0..* Observation A imaging examination result in an Australian healthcare context
    Constraints: inv-obs-0, inv-obs-1
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    ... Slices for category 1..* CodeableConcept Relevant diagnostic imaging category: service, modality and anatomic region
    Slice: Unordered, Open by value:coding.system, value:coding.code
    .... category:diagImg 1..1 CodeableConcept Observation generated by imaging
    ..... coding 1..* Coding Code defined by a terminology system
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: imaging
    .... category:anatomicRegionOfInterest 0..* CodeableConcept Anatomic Region Of Interest
    Binding: Imaging Anatomic Region Of Interest . (extensible)
    ..... coding
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://snomed.info/sct
    ... code 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    ... effective[x] 1..1 dateTime, Period, Timing, instant Time of diagnostic imaging examination
    ... value[x] C 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
    ... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    ... bodySite C 0..1 CodeableConcept Observed body part
    Binding: Body Site . (preferred)
    ... hasMember C 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result) Individual examinations in a group or study series
    ... component 0..* BackboneElement Individual examinations in a group or study series
    .... code 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    .... value[x] C 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual component result
    .... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.category:anatomicRegionOfInterest Base extensible Imaging Anatomic Region Of Interest . ⏿1.0.0 tx.ontoserver.csiro.au
    Observation.code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.bodySite Base preferred Body Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.component.​code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au

    Constraints

    Id Grade Path(s) Description Expression
    inv-obs-0 error Observation An imaging result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 0..* Observation A imaging examination result in an Australian healthcare context
    Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1
    ... 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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier Σ 0..* Identifier Business Identifier for observation
    ... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    ... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    ... status ?!Σ 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    ... Slices for category 1..* CodeableConcept Relevant diagnostic imaging category: service, modality and anatomic region
    Slice: Unordered, Open by value:coding.system, value:coding.code
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    .... category:diagImg 1..1 CodeableConcept Observation generated by imaging
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... coding Σ 1..* Coding Code defined by a terminology system
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 1..1 code Symbol in syntax defined by the system
    Fixed Value: imaging
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... text Σ 0..1 string Plain text representation of the concept
    .... category:anatomicRegionOfInterest 0..* CodeableConcept Anatomic Region Of Interest
    Binding: Imaging Anatomic Region Of Interest . (extensible)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... coding Σ 0..* Coding Code defined by a terminology system
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://snomed.info/sct
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... text Σ 0..1 string Plain text representation of the concept
    ... code Σ 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    ... subject Σ 1..1 Reference(Patient) Who and/or what the observation is about
    ... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    ... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
    ... effective[x] Σ 1..1 Time of diagnostic imaging examination
    .... effectiveDateTime dateTime
    .... effectivePeriod Period
    .... effectiveTiming Timing
    .... effectiveInstant instant
    ... issued Σ 0..1 instant Date/Time this version was made available
    ... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
    ... value[x] ΣC 0..1 Actual result
    .... valueQuantity Quantity
    .... valueCodeableConcept CodeableConcept
    .... valueString string
    .... valueBoolean boolean
    .... valueInteger integer
    .... valueRange Range
    .... valueRatio Ratio
    .... valueSampledData SampledData
    .... valueTime time
    .... valueDateTime dateTime
    .... valuePeriod Period
    ... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    ... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    ... note 0..* Annotation Comments about the observation
    ... bodySite C 0..1 CodeableConcept Observed body part
    Binding: Body Site . (preferred)
    ... method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.
    ... specimen 0..1 Reference(Specimen) Specimen used for this observation
    ... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    ... referenceRange C 0..* BackboneElement Provides guide for interpretation
    Constraints: obs-3
    .... 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
    .... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
    .... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
    .... type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
    .... appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
    .... age 0..1 Range Applicable age range, if relevant
    .... text 0..1 string Text based reference range in an observation
    ... hasMember ΣC 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result) Individual examinations in a group or study series
    ... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
    ... component Σ 0..* BackboneElement Individual examinations in a group or study series
    .... 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 Σ 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    .... value[x] ΣC 0..1 Actual component result
    ..... valueQuantity Quantity
    ..... valueCodeableConcept CodeableConcept
    ..... valueString string
    ..... valueBoolean boolean
    ..... valueInteger integer
    ..... valueRange Range
    ..... valueRatio Ratio
    ..... valueSampledData SampledData
    ..... valueTime time
    ..... valueDateTime dateTime
    ..... valuePeriod Period
    .... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    .... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    .... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:diagImg Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:anatomicRegionOfInterest Base extensible Imaging Anatomic Region Of Interest . ⏿1.0.0 tx.ontoserver.csiro.au
    Observation.code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
    Observation.bodySite Base preferred Body Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
    Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
    Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
    Observation.component.​code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-obs-0 error Observation An imaging result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
    obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
    obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

    This structure is derived from Observation

    Summary

    Mandatory: 7 elements(1 nested mandatory element)
    Fixed: 3 elements

    Structures

    This structure refers to these other structures:

    Extensions

    This structure refers to these extensions:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Observation.category

    Maturity: 1

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 0..* Observation A imaging examination result in an Australian healthcare context
    Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... Slices for category 1..* CodeableConcept Relevant diagnostic imaging category: service, modality and anatomic region
    Slice: Unordered, Open by value:coding.system, value:coding.code
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    .... category:diagImg 1..1 CodeableConcept Observation generated by imaging
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    ..... coding Σ 1..* Coding Code defined by a terminology system
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
    ...... code Σ 1..1 code Symbol in syntax defined by the system
    Fixed Value: imaging
    .... category:anatomicRegionOfInterest 0..* CodeableConcept Anatomic Region Of Interest
    Binding: Imaging Anatomic Region Of Interest . (extensible)
    ... code Σ 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    ... subject Σ 1..1 Reference(Patient) Who and/or what the observation is about
    ... effective[x] Σ 1..1 Time of diagnostic imaging examination
    .... effectiveDateTime dateTime
    .... effectivePeriod Period
    .... effectiveTiming Timing
    .... effectiveInstant instant
    ... value[x] ΣC 0..1 Actual result
    .... valueQuantity Quantity
    .... valueCodeableConcept CodeableConcept
    .... valueString string
    .... valueBoolean boolean
    .... valueInteger integer
    .... valueRange Range
    .... valueRatio Ratio
    .... valueSampledData SampledData
    .... valueTime time
    .... valueDateTime dateTime
    .... valuePeriod Period
    ... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    ... bodySite C 0..1 CodeableConcept Observed body part
    Binding: Body Site . (preferred)
    ... hasMember ΣC 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result) Individual examinations in a group or study series
    ... component Σ 0..* BackboneElement Individual examinations in a group or study series
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... code Σ 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    .... value[x] ΣC 0..1 Actual component result
    ..... valueQuantity Quantity
    ..... valueCodeableConcept CodeableConcept
    ..... valueString string
    ..... valueBoolean boolean
    ..... valueInteger integer
    ..... valueRange Range
    ..... valueRatio Ratio
    ..... valueSampledData SampledData
    ..... valueTime time
    ..... valueDateTime dateTime
    ..... valuePeriod Period
    .... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:diagImg Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:anatomicRegionOfInterest Base extensible Imaging Anatomic Region Of Interest . ⏿1.0.0 tx.ontoserver.csiro.au
    Observation.code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.bodySite Base preferred Body Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.component.​code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-obs-0 error Observation An imaging result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
    obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

    Differential View

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 0..* Observation A imaging examination result in an Australian healthcare context
    Constraints: inv-obs-0, inv-obs-1
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    ... Slices for category 1..* CodeableConcept Relevant diagnostic imaging category: service, modality and anatomic region
    Slice: Unordered, Open by value:coding.system, value:coding.code
    .... category:diagImg 1..1 CodeableConcept Observation generated by imaging
    ..... coding 1..* Coding Code defined by a terminology system
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: imaging
    .... category:anatomicRegionOfInterest 0..* CodeableConcept Anatomic Region Of Interest
    Binding: Imaging Anatomic Region Of Interest . (extensible)
    ..... coding
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://snomed.info/sct
    ... code 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    ... effective[x] 1..1 dateTime, Period, Timing, instant Time of diagnostic imaging examination
    ... value[x] C 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
    ... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    ... bodySite C 0..1 CodeableConcept Observed body part
    Binding: Body Site . (preferred)
    ... hasMember C 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result) Individual examinations in a group or study series
    ... component 0..* BackboneElement Individual examinations in a group or study series
    .... code 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    .... value[x] C 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual component result
    .... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.category:anatomicRegionOfInterest Base extensible Imaging Anatomic Region Of Interest . ⏿1.0.0 tx.ontoserver.csiro.au
    Observation.code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.bodySite Base preferred Body Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.component.​code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au

    Constraints

    Id Grade Path(s) Description Expression
    inv-obs-0 error Observation An imaging result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 0..* Observation A imaging examination result in an Australian healthcare context
    Constraints: obs-6, obs-7, inv-obs-0, inv-obs-1
    ... 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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:bodyStructure C 0..1 Reference(BodyStructure) Target anatomic location or structure
    URL: http://hl7.org/fhir/StructureDefinition/bodySite
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier Σ 0..* Identifier Business Identifier for observation
    ... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    ... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    ... status ?!Σ 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    ... Slices for category 1..* CodeableConcept Relevant diagnostic imaging category: service, modality and anatomic region
    Slice: Unordered, Open by value:coding.system, value:coding.code
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    .... category:diagImg 1..1 CodeableConcept Observation generated by imaging
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... coding Σ 1..* Coding Code defined by a terminology system
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 1..1 code Symbol in syntax defined by the system
    Fixed Value: imaging
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... text Σ 0..1 string Plain text representation of the concept
    .... category:anatomicRegionOfInterest 0..* CodeableConcept Anatomic Region Of Interest
    Binding: Imaging Anatomic Region Of Interest . (extensible)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... coding Σ 0..* Coding Code defined by a terminology system
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://snomed.info/sct
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... text Σ 0..1 string Plain text representation of the concept
    ... code Σ 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    ... subject Σ 1..1 Reference(Patient) Who and/or what the observation is about
    ... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    ... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
    ... effective[x] Σ 1..1 Time of diagnostic imaging examination
    .... effectiveDateTime dateTime
    .... effectivePeriod Period
    .... effectiveTiming Timing
    .... effectiveInstant instant
    ... issued Σ 0..1 instant Date/Time this version was made available
    ... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
    ... value[x] ΣC 0..1 Actual result
    .... valueQuantity Quantity
    .... valueCodeableConcept CodeableConcept
    .... valueString string
    .... valueBoolean boolean
    .... valueInteger integer
    .... valueRange Range
    .... valueRatio Ratio
    .... valueSampledData SampledData
    .... valueTime time
    .... valueDateTime dateTime
    .... valuePeriod Period
    ... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    ... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    ... note 0..* Annotation Comments about the observation
    ... bodySite C 0..1 CodeableConcept Observed body part
    Binding: Body Site . (preferred)
    ... method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.
    ... specimen 0..1 Reference(Specimen) Specimen used for this observation
    ... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    ... referenceRange C 0..* BackboneElement Provides guide for interpretation
    Constraints: obs-3
    .... 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
    .... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
    .... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
    .... type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
    .... appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
    .... age 0..1 Range Applicable age range, if relevant
    .... text 0..1 string Text based reference range in an observation
    ... hasMember ΣC 0..* Reference(AU Base Diagnostic Result | AU Base Diagnostic Imaging Result) Individual examinations in a group or study series
    ... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
    ... component Σ 0..* BackboneElement Individual examinations in a group or study series
    .... 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 Σ 1..1 CodeableConcept Diagnostic imaging examination or study
    Binding: Imaging Procedure . (preferred)
    .... value[x] ΣC 0..1 Actual component result
    ..... valueQuantity Quantity
    ..... valueCodeableConcept CodeableConcept
    ..... valueString string
    ..... valueBoolean boolean
    ..... valueInteger integer
    ..... valueRange Range
    ..... valueRatio Ratio
    ..... valueSampledData SampledData
    ..... valueTime time
    ..... valueDateTime dateTime
    ..... valuePeriod Period
    .... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    .... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    .... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:diagImg Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:anatomicRegionOfInterest Base extensible Imaging Anatomic Region Of Interest . ⏿1.0.0 tx.ontoserver.csiro.au
    Observation.code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
    Observation.bodySite Base preferred Body Site . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
    Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
    Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
    Observation.component.​code Base preferred Imaging Procedure . ⏿1.0.2 tx.ontoserver.csiro.au
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-obs-0 error Observation An imaging result shall at least have value or data absent reason or a child observation with a value or data absent reason value.exists() or dataAbsentReason.exists() or hasMember.exists() or component.value.exists() or component.dataAbsentReason.exists()
    inv-obs-1 error Observation BodyStructure Reference extension shall only be present if the body site is not present bodySite.exists() implies extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
    obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
    obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
    obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

    This structure is derived from Observation

    Summary

    Mandatory: 7 elements(1 nested mandatory element)
    Fixed: 3 elements

    Structures

    This structure refers to these other structures:

    Extensions

    This structure refers to these extensions:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Observation.category

    Maturity: 1

     

    Other representations of profile: CSV, Excel, Schematron