AU Core Implementation Guide
0.2.2-preview - Preview
This page is part of the Australian Core IG (v0.2.2-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-lipid-result | Version: 0.2.2-preview | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreLipidResult | ||
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 lipids observations associated with a patient and with standard coding and units of measure. It is based on the AU Core Pathology Result Observation and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource 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 suppliedConformance 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 workflowUsage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCorePathologyResult
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | AUCorePathologyResult | Individual lipid result in an Australian healthcare context au-core-lipid-01: A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio |
category | 2..* | CodeableConcept | Classification of the service requested as laboratory + more specific discipline where available | |
category:specificDiscipline | 1..1 | CodeableConcept | Chemistry | |
coding | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | |
code | 1..1 | CodeableConcept | Individual Lipid Test Binding: Lipid Result Reporting (required) | |
valueQuantity | C | 0..1 | Quantity | Actual result |
value | 1..1 | decimal | Numerical value (with implicit precision) | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
code | 0..1 | code | Coded form of the unit Fixed Value: mmol/L | |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.code | required | LipidResultReporting |
Id | Grade | Path(s) | Details | Requirements |
au-core-lipid-01 | error | Observation | A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio : (code.coding.code!='32309-7' and value.value.exists()) implies (value.unit.exists() and value.code.exists()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | AUCorePathologyResult | Individual lipid result in an Australian healthcare context au-core-lipid-01: A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio |
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 | 2..* | CodeableConcept | Classification of the service requested as laboratory + more specific discipline where available Slice: Unordered, Open by value:coding.system, value:coding.code Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:lab | 1..1 | CodeableConcept | Observation generated by laboratories 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: laboratory |
category:specificDiscipline | 1..1 | CodeableConcept | Chemistry Binding: https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 (extensible) | |
code | SΣ | 1..1 | CodeableConcept | Individual Lipid Test Binding: Lipid Result Reporting (required) |
subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
effective[x] | SΣC | 1..1 | Time of specimen collection | |
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 |
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueSampledData | SampledData | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
value[x]:valueQuantity | SΣC | 0..1 | Quantity | Actual result |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
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 |
method | S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. |
specimen | S | 0..1 | Reference(AU Core Specimen) | Specimen used for this observation |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
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 Pathology 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 tests in a group or panel |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Individual pathology test Binding: https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 (extensible) |
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:lab | preferred | ObservationCategoryCodes |
Observation.category:specificDiscipline | extensible | https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 |
Observation.code | required | LipidResultReporting |
Observation.value[x]:valueQuantity.comparator | required | QuantityComparator |
Observation.dataAbsentReason | extensible | DataAbsentReason |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Observation.method | example | ObservationMethods |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
Observation.component.code | extensible | https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Id | Grade | Path(s) | Details | Requirements |
au-core-lipid-01 | error | Observation | A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio : (code.coding.code!='32309-7' and value.value.exists()) implies (value.unit.exists() and value.code.exists()) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | AUCorePathologyResult | Individual lipid result in an Australian healthcare context au-core-lipid-01: A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio | ||||
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 | 2..* | CodeableConcept | Classification of the service requested as laboratory + more specific discipline where available Slice: Unordered, Open by value:coding.system, value:coding.code Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:lab | 1..1 | CodeableConcept | Observation generated by laboratories 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: laboratory | ||||
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:specificDiscipline | 1..1 | CodeableConcept | Chemistry Binding: https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-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://terminology.hl7.org/CodeSystem/v2-0074 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | ||||
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 | Individual Lipid Test Binding: Lipid Result Reporting (required) | ||||
subject | SΣ | 1..1 | Reference(AU Core 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] | SΣC | 1..1 | Time of specimen collection | |||||
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 | ||||
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
value[x]:valueQuantity | SΣC | 0..1 | Quantity | Actual result | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
code | Σ | 0..1 | code | Coded form of the unit Fixed Value: mmol/L | ||||
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 | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||
specimen | S | 0..1 | Reference(AU Core Specimen) | Specimen used for this observation | ||||
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 | ||||
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 Pathology 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 tests in a group or panel | ||||
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 | Individual pathology test Binding: https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 (extensible) | ||||
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-lipid-01 | error | Observation | A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio : (code.coding.code!='32309-7' and value.value.exists()) implies (value.unit.exists() and value.code.exists()) |
This structure is derived from AUCorePathologyResult
Differential View
This structure is derived from AUCorePathologyResult
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | AUCorePathologyResult | Individual lipid result in an Australian healthcare context au-core-lipid-01: A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio |
category | 2..* | CodeableConcept | Classification of the service requested as laboratory + more specific discipline where available | |
category:specificDiscipline | 1..1 | CodeableConcept | Chemistry | |
coding | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | |
code | 1..1 | CodeableConcept | Individual Lipid Test Binding: Lipid Result Reporting (required) | |
valueQuantity | C | 0..1 | Quantity | Actual result |
value | 1..1 | decimal | Numerical value (with implicit precision) | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
code | 0..1 | code | Coded form of the unit Fixed Value: mmol/L | |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.code | required | LipidResultReporting |
Id | Grade | Path(s) | Details | Requirements |
au-core-lipid-01 | error | Observation | A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio : (code.coding.code!='32309-7' and value.value.exists()) implies (value.unit.exists() and value.code.exists()) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | AUCorePathologyResult | Individual lipid result in an Australian healthcare context au-core-lipid-01: A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio |
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 | 2..* | CodeableConcept | Classification of the service requested as laboratory + more specific discipline where available Slice: Unordered, Open by value:coding.system, value:coding.code Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:lab | 1..1 | CodeableConcept | Observation generated by laboratories 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: laboratory |
category:specificDiscipline | 1..1 | CodeableConcept | Chemistry Binding: https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 (extensible) | |
code | SΣ | 1..1 | CodeableConcept | Individual Lipid Test Binding: Lipid Result Reporting (required) |
subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
effective[x] | SΣC | 1..1 | Time of specimen collection | |
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 |
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueSampledData | SampledData | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
value[x]:valueQuantity | SΣC | 0..1 | Quantity | Actual result |
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
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 |
method | S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. |
specimen | S | 0..1 | Reference(AU Core Specimen) | Specimen used for this observation |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
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 Pathology 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 tests in a group or panel |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Individual pathology test Binding: https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 (extensible) |
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:lab | preferred | ObservationCategoryCodes |
Observation.category:specificDiscipline | extensible | https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 |
Observation.code | required | LipidResultReporting |
Observation.value[x]:valueQuantity.comparator | required | QuantityComparator |
Observation.dataAbsentReason | extensible | DataAbsentReason |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Observation.method | example | ObservationMethods |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
Observation.component.code | extensible | https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Id | Grade | Path(s) | Details | Requirements |
au-core-lipid-01 | error | Observation | A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio : (code.coding.code!='32309-7' and value.value.exists()) implies (value.unit.exists() and value.code.exists()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | AUCorePathologyResult | Individual lipid result in an Australian healthcare context au-core-lipid-01: A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio | ||||
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 | 2..* | CodeableConcept | Classification of the service requested as laboratory + more specific discipline where available Slice: Unordered, Open by value:coding.system, value:coding.code Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:lab | 1..1 | CodeableConcept | Observation generated by laboratories 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: laboratory | ||||
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:specificDiscipline | 1..1 | CodeableConcept | Chemistry Binding: https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-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://terminology.hl7.org/CodeSystem/v2-0074 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | ||||
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 | Individual Lipid Test Binding: Lipid Result Reporting (required) | ||||
subject | SΣ | 1..1 | Reference(AU Core 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] | SΣC | 1..1 | Time of specimen collection | |||||
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 | ||||
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
value[x]:valueQuantity | SΣC | 0..1 | Quantity | Actual result | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
code | Σ | 0..1 | code | Coded form of the unit Fixed Value: mmol/L | ||||
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 | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||
specimen | S | 0..1 | Reference(AU Core Specimen) | Specimen used for this observation | ||||
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 | ||||
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 Pathology 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 tests in a group or panel | ||||
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 | Individual pathology test Binding: https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 (extensible) | ||||
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:lab | preferred | ObservationCategoryCodes | ||||
Observation.category:specificDiscipline | extensible | https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | ||||
Observation.code | required | LipidResultReporting | ||||
Observation.value[x]:valueQuantity.comparator | required | QuantityComparator | ||||
Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
Observation.method | example | ObservationMethods | ||||
Observation.specimen.type | extensible | ResourceType | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
Observation.hasMember.type | extensible | ResourceType | ||||
Observation.component.code | extensible | https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
Id | Grade | Path(s) | Details | Requirements |
au-core-lipid-01 | error | Observation | A lipid result value shall have unit, system and code if the test is not Cholesterol/HDL Cholesterol ratio : (code.coding.code!='32309-7' and value.value.exists()) implies (value.unit.exists() and value.code.exists()) |
This structure is derived from AUCorePathologyResult
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:target
patient.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:target
patient.identifier
(e.g. patient.identifier=[system|][code]
)GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and a category code = laboratory
(how to search by reference and how to search by token)
patient
and code
search parameters:
_revinclude
parameters: Provenance:target
patient.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:target
patient.identifier
(e.g. patient.identifier=[system|][code]
)date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
)GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&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 = laboratory
(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:target
patient.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|laboratory&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:target
patient.identifier
(e.g. patient.identifier=[system|][code]
code
(e.g.code={system|}[code],{system|}[code],...
)date
comparators: gt,lt,ge,le
date
(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)