AU Core Implementation Guide
0.2.1-preview - Preview
AU Core Implementation Guide
0.2.1-preview - Preview
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 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticresult-imag | Version: 0.2.1-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreDiagnosticImagingResult | ||
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 an Observation resource to record, search, and fetch diagnostic imaging results associated with a patient. It is based on the AU Base Diagnostic Imaging Result profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
A resource conforming to this profile is conformant to:
final, and Observation.performer is supplied, noting that IPS extensibly binds Observation.code to LOINCConformance 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.
Observation.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.Observation.code.text and/or Observation.code.coding.display so that client applications can at least display the observation even if the client application does not recognise the code supplied.Observation.value, or set of results using either Observation.component.value or Observation.hasMember.
Observation.identifier may contain the same identifier as in the order or report connecting the resources that are related to a single request fulfilment workflowSpecific feedback is sought on supporting complex body site information in Observations. Coded laterality (or other qualifiers) can be supplied using a post-coordinated concept e.g. Observation.bodySite.coding.code="71341001:272741003=7771000" (see Observation/bonedensity-simple-precon) or by use of the extension bodySite to reference a BodyStructure resource (see example Observation/bonedensity-simple-contained). Additional body site information can only be supported by referenced BodyStructure resource.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseDiagnosticImagingResult
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | C | 0..* | AUBaseDiagnosticImagingResult | A imaging examination result in an Australian healthcare context au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present |
  identifier | S | 0..* | Identifier | Business Identifier for observation |
| status | S | 1..1 | code | preliminary | final | amended + Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required) |
| category | S | 1..* | CodeableConcept | Relevant diagnostic imaging category: service, modality and anatomic region |
| code | S | 1..1 | CodeableConcept | Diagnostic imaging examination or study |
 subject | S | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
| effective[x] | SC | 1..1 | dateTime, Period | Date, and optionally time, the imaging study was performed au-core-obs-01: Date shall be at least to day |
| performer | S | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation |
| value[x] | SC | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result |
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing |
| interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. |
| note | S | 0..* | Annotation | Comments about the observation |
| bodySite | SC | 1..1 | CodeableConcept | Observed body part Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT |
| method | S | 0..1 | CodeableConcept | How it was done |
 referenceRange | S | 0..* | BackboneElement | Provides guide for interpretation |
 low | S | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | S | 0..1 | SimpleQuantity | High Range, if relevant |
| type | S | 0..1 | CodeableConcept | Reference range qualifier |
 text | S | 0..1 | string | Text based reference range in an observation |
| hasMember | S | 0..* | Reference(AU Core Diagnostic Imaging Result Observation) | Individual observations in a group, study, or panel |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
 component | SC | 0..* | BackboneElement | Individual examinations in a group or study series au-core-obs-06: The component shall at least have a value or a data absent reason |
 code | S | 1..1 | CodeableConcept | Diagnostic imaging examination or study |
| value[x] | SC | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result |
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the component result is missing |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 |
| Observation.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 | |
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-05 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| au-core-obs-06 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | AUBaseDiagnosticImagingResult | A imaging examination result in an Australian healthcare context au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 0..* | Identifier | Business Identifier for observation |
| status | ?!SΣ | 1..1 | code | preliminary | final | amended + Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required) |
 Slices for category | S | 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: https://healthterminologies.gov.au/fhir/ValueSet/imaging-anatomic-region-of-interest-1 (extensible) | |
| code | SΣ | 1..1 | CodeableConcept | Diagnostic imaging examination or study Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (preferred) |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
 effective[x] | SΣC | 1..1 | Date, and optionally time, the imaging study was performed au-core-obs-01: Date shall be at least to day | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation |
| value[x] | SΣ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 | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
| note | S | 0..* | Annotation | Comments about the observation |
| bodySite | SC | 1..1 | CodeableConcept | Observed body part Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT |
| bodySite | 0..1 | Reference(BodyStructure) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |
| method | S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. |
| referenceRange | SC | 0..* | BackboneElement | Provides guide for interpretation |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| low | SC | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | SC | 0..1 | SimpleQuantity | High Range, if relevant |
| type | S | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
| text | S | 0..1 | string | Text based reference range in an observation |
| hasMember | SΣC | 0..* | Reference(AU Core Diagnostic Imaging Result Observation) | Individual observations in a group, study, or panel |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| component | SΣC | 0..* | BackboneElement | Individual examinations in a group or study series au-core-obs-06: The component shall at least have a value or a data absent reason |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Diagnostic imaging examination or study Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (preferred) |
| value[x] | SΣ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 | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.category:diagImg | preferred | ObservationCategoryCodes |
| Observation.category:anatomicRegionOfInterest | extensible | https://healthterminologies.gov.au/fhir/ValueSet/imaging-anatomic-region-of-interest-1 |
| Observation.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 |
| Observation.dataAbsentReason | extensible | DataAbsentReason |
| Observation.interpretation | extensible | ObservationInterpretationCodes |
| Observation.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Observation.method | example | ObservationMethods |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
| Observation.component.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 | |
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-05 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| au-core-obs-06 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | AUBaseDiagnosticImagingResult | A imaging examination result in an Australian healthcare context au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 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 | ?!SΣ | 1..1 | code | preliminary | final | amended + Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required) | ||||
| Slices for category | S | 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: https://healthterminologies.gov.au/fhir/ValueSet/imaging-anatomic-region-of-interest-1 (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 | SΣ | 1..1 | CodeableConcept | Diagnostic imaging examination or study Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (preferred) | ||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about | ||||
| focus | ΣTU | 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] | SΣC | 1..1 | Date, and optionally time, the imaging study was performed au-core-obs-01: Date shall be at least to day | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation | ||||
| value[x] | SΣ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 | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||
| note | S | 0..* | Annotation | Comments about the observation | ||||
| bodySite | SC | 1..1 | CodeableConcept | Observed body part Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| bodySite | 0..1 | Reference(BodyStructure) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| method | S | 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 | SC | 0..* | BackboneElement | Provides guide for interpretation | ||||
| 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 | SC | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | SC | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | S | 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 | S | 0..1 | string | Text based reference range in an observation | ||||
| hasMember | SΣC | 0..* | Reference(AU Core Diagnostic Imaging Result Observation) | Individual observations in a group, study, or panel | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component | SΣC | 0..* | BackboneElement | Individual examinations in a group or study series au-core-obs-06: The component shall at least have a value or a data absent reason | ||||
| 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 | SΣ | 1..1 | CodeableConcept | Diagnostic imaging examination or study Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (preferred) | ||||
| value[x] | SΣ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 | SC | 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 | |||||
| Documentation for this format | ||||||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 | |
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-06 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() |
This structure is derived from AUBaseDiagnosticImagingResult
Summary
Mandatory: 1 element (1 nested mandatory element)
Must-Support: 23 elements
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUBaseDiagnosticImagingResult
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | AUBaseDiagnosticImagingResult | A imaging examination result in an Australian healthcare context au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present |
| identifier | S | 0..* | Identifier | Business Identifier for observation |
| status | S | 1..1 | code | preliminary | final | amended + Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required) |
| category | S | 1..* | CodeableConcept | Relevant diagnostic imaging category: service, modality and anatomic region |
| code | S | 1..1 | CodeableConcept | Diagnostic imaging examination or study |
| subject | S | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
| effective[x] | SC | 1..1 | dateTime, Period | Date, and optionally time, the imaging study was performed au-core-obs-01: Date shall be at least to day |
| performer | S | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation |
| value[x] | SC | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result |
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing |
| interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. |
| note | S | 0..* | Annotation | Comments about the observation |
| bodySite | SC | 1..1 | CodeableConcept | Observed body part Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT |
| method | S | 0..1 | CodeableConcept | How it was done |
| referenceRange | S | 0..* | BackboneElement | Provides guide for interpretation |
| low | S | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | S | 0..1 | SimpleQuantity | High Range, if relevant |
| type | S | 0..1 | CodeableConcept | Reference range qualifier |
| text | S | 0..1 | string | Text based reference range in an observation |
| hasMember | S | 0..* | Reference(AU Core Diagnostic Imaging Result Observation) | Individual observations in a group, study, or panel |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| component | SC | 0..* | BackboneElement | Individual examinations in a group or study series au-core-obs-06: The component shall at least have a value or a data absent reason |
| code | S | 1..1 | CodeableConcept | Diagnostic imaging examination or study |
| value[x] | SC | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result |
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the component result is missing |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 |
| Observation.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 | |
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-05 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| au-core-obs-06 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | AUBaseDiagnosticImagingResult | A imaging examination result in an Australian healthcare context au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | Business Identifier for observation |
| status | ?!SΣ | 1..1 | code | preliminary | final | amended + Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required) |
| Slices for category | S | 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: https://healthterminologies.gov.au/fhir/ValueSet/imaging-anatomic-region-of-interest-1 (extensible) | |
| code | SΣ | 1..1 | CodeableConcept | Diagnostic imaging examination or study Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (preferred) |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
| effective[x] | SΣC | 1..1 | Date, and optionally time, the imaging study was performed au-core-obs-01: Date shall be at least to day | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation |
| value[x] | SΣ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 | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
| note | S | 0..* | Annotation | Comments about the observation |
| bodySite | SC | 1..1 | CodeableConcept | Observed body part Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT |
| bodySite | 0..1 | Reference(BodyStructure) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |
| method | S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. |
| referenceRange | SC | 0..* | BackboneElement | Provides guide for interpretation |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| low | SC | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | SC | 0..1 | SimpleQuantity | High Range, if relevant |
| type | S | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
| text | S | 0..1 | string | Text based reference range in an observation |
| hasMember | SΣC | 0..* | Reference(AU Core Diagnostic Imaging Result Observation) | Individual observations in a group, study, or panel |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| component | SΣC | 0..* | BackboneElement | Individual examinations in a group or study series au-core-obs-06: The component shall at least have a value or a data absent reason |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Diagnostic imaging examination or study Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (preferred) |
| value[x] | SΣ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 | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.category:diagImg | preferred | ObservationCategoryCodes |
| Observation.category:anatomicRegionOfInterest | extensible | https://healthterminologies.gov.au/fhir/ValueSet/imaging-anatomic-region-of-interest-1 |
| Observation.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 |
| Observation.dataAbsentReason | extensible | DataAbsentReason |
| Observation.interpretation | extensible | ObservationInterpretationCodes |
| Observation.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Observation.method | example | ObservationMethods |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
| Observation.component.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 | |
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-05 | error | Observation | If there is no component or hasMember element then at least value or data absent reason shall be present : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| au-core-obs-06 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | AUBaseDiagnosticImagingResult | A imaging examination result in an Australian healthcare context au-core-obs-05: If there is no component or hasMember element then at least value or data absent reason shall be present | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 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 | ?!SΣ | 1..1 | code | preliminary | final | amended + Binding: https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 (required) | ||||
| Slices for category | S | 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: https://healthterminologies.gov.au/fhir/ValueSet/imaging-anatomic-region-of-interest-1 (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 | SΣ | 1..1 | CodeableConcept | Diagnostic imaging examination or study Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (preferred) | ||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about | ||||
| focus | ΣTU | 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] | SΣC | 1..1 | Date, and optionally time, the imaging study was performed au-core-obs-01: Date shall be at least to day | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson) | Who is responsible for the observation | ||||
| value[x] | SΣ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 | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||
| note | S | 0..* | Annotation | Comments about the observation | ||||
| bodySite | SC | 1..1 | CodeableConcept | Observed body part Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-obs-04: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| bodySite | 0..1 | Reference(BodyStructure) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| method | S | 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 | SC | 0..* | BackboneElement | Provides guide for interpretation | ||||
| 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 | SC | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | SC | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | S | 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 | S | 0..1 | string | Text based reference range in an observation | ||||
| hasMember | SΣC | 0..* | Reference(AU Core Diagnostic Imaging Result Observation) | Individual observations in a group, study, or panel | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component | SΣC | 0..* | BackboneElement | Individual examinations in a group or study series au-core-obs-06: The component shall at least have a value or a data absent reason | ||||
| 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 | SΣ | 1..1 | CodeableConcept | Diagnostic imaging examination or study Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (preferred) | ||||
| value[x] | SΣ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 | SC | 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | https://healthterminologies.gov.au/fhir/ValueSet/observationstatus-result-available-1 | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.category:diagImg | preferred | ObservationCategoryCodes | ||||
| Observation.category:anatomicRegionOfInterest | extensible | https://healthterminologies.gov.au/fhir/ValueSet/imaging-anatomic-region-of-interest-1 | ||||
| Observation.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.hasMember.type | extensible | ResourceType | ||||
| Observation.component.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 | |
| au-core-obs-04 | error | Observation.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| au-core-obs-06 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() |
This structure is derived from AUBaseDiagnosticImagingResult
Summary
Mandatory: 1 element (1 nested mandatory element)
Must-Support: 23 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
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+category+date | SHALL | reference+token+date |
|
| patient+code | SHALL | reference+token |
|
| patient+category+status | SHOULD | reference+token+token |
|
| patient+code+date | SHOULD | reference+token+date |
|
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
The following search parameters and search parameter combinations SHALL be supported:
patient search parameter:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Observation?patient={Type/}[id]
or optionally GET [base]/Observation?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient (how to search by reference and how to search by token)
patient and category search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|imaging
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category (how to search by reference and how to search by token)
patient and code search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])code (e.g.code={system|}[code],{system|}[code],...)GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and observation code(s). The Observation code parameter searches `Observation.code only. (how to search by reference and how to search by token)
patient and category and date search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])date comparators: gt,lt,ge,ledate (e.g.date=[date]&date=[date]]&...)GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|imaging&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and a category code = imaging (how to search by reference and how to search by token and how to search by date)
The following search parameters and search parameter combinations SHOULD be supported:
patient and category and status search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])status (e.g.status={system|}[code],{system|}[code],...)GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|imaging&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category and status (how to search by reference and how to search by token)
patient and code and date search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code]code (e.g.code={system|}[code],{system|}[code],...)date comparators: gt,lt,ge,ledate (e.g.date=[date]&date=[date]]&...)GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and observation code(s). (how to search by reference and how to search by token and how to search by date)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.2.1-preview based on FHIR 4.0.1. Generated 2023-08-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change