STARS Implementation Guide
0.1.0 - ci-build
STARS Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Official URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-observation-result | Version: 0.1.0 | |||
Draft as of 2023-04-26 | Computable Name: CsiroStarsObservationResultProfile |
Results, Measurements and simple assertions
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
language | 0..0 | |||
identifier | 1..1 | Identifier | Business Identifier for observation | |
basedOn | 0..1 | Reference(CSIRO STARS ServiceRequest Profile) | Fulfills plan, proposal or order | |
partOf | 0..0 | |||
category | 0..0 | |||
code | 1..1 | CodeableConcept | Type of observation (code / type) Binding: STARS Analysis Value Set (required) | |
subject | 0..0 | |||
focus | 0..0 | |||
encounter | 0..0 | |||
effective[x] | 0..1 | instant | Clinically relevant time/time-period for observation | |
performer | 0..0 | |||
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. | |
note | 0..1 | Annotation | Comments about the observation | |
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..1 | Reference(CSIRO STARS Specimen Profile) | Specimen used for this observation | |
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | 0..0 | |||
derivedFrom | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
Observation.code | required | AnalysisValueSet (a valid code from STARS Legacy Analysis Code System) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | Business Identifier for observation |
basedOn | Σ | 0..1 | Reference(CSIRO STARS ServiceRequest Profile) | Fulfills plan, proposal or order |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: STARS Analysis Value Set (required) |
effective[x] | Σ | 0..1 | instant | Clinically relevant time/time-period for observation |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
note | 0..1 | Annotation | Comments about the observation | |
specimen | 0..1 | Reference(CSIRO STARS Specimen Profile) | Specimen used for this observation | |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.code | required | AnalysisValueSet (a valid code from STARS Legacy Analysis Code System) |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions |
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 |
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 | Σ | 1..1 | Identifier | Business Identifier for observation |
basedOn | Σ | 0..1 | Reference(CSIRO STARS ServiceRequest Profile) | Fulfills plan, proposal or order |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: STARS Analysis Value Set (required) |
effective[x] | Σ | 0..1 | instant | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this version was made available |
value[x] | ΣC | 0..1 | Actual result | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueSampledData | SampledData | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
note | 0..1 | Annotation | Comments about the observation | |
specimen | 0..1 | Reference(CSIRO STARS Specimen Profile) | Specimen used for this observation | |
component | Σ | 0..* | BackboneElement | Component results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
value[x] | Σ | 0..1 | Actual component result | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueSampledData | SampledData | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.code | required | AnalysisValueSet (a valid code from STARS Legacy Analysis Code System) |
Observation.dataAbsentReason | extensible | DataAbsentReason |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
This structure is derived from Observation
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
language | 0..0 | |||
identifier | 1..1 | Identifier | Business Identifier for observation | |
basedOn | 0..1 | Reference(CSIRO STARS ServiceRequest Profile) | Fulfills plan, proposal or order | |
partOf | 0..0 | |||
category | 0..0 | |||
code | 1..1 | CodeableConcept | Type of observation (code / type) Binding: STARS Analysis Value Set (required) | |
subject | 0..0 | |||
focus | 0..0 | |||
encounter | 0..0 | |||
effective[x] | 0..1 | instant | Clinically relevant time/time-period for observation | |
performer | 0..0 | |||
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. | |
note | 0..1 | Annotation | Comments about the observation | |
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..1 | Reference(CSIRO STARS Specimen Profile) | Specimen used for this observation | |
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | 0..0 | |||
derivedFrom | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
Observation.code | required | AnalysisValueSet (a valid code from STARS Legacy Analysis Code System) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | Business Identifier for observation |
basedOn | Σ | 0..1 | Reference(CSIRO STARS ServiceRequest Profile) | Fulfills plan, proposal or order |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: STARS Analysis Value Set (required) |
effective[x] | Σ | 0..1 | instant | Clinically relevant time/time-period for observation |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
note | 0..1 | Annotation | Comments about the observation | |
specimen | 0..1 | Reference(CSIRO STARS Specimen Profile) | Specimen used for this observation | |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.code | required | AnalysisValueSet (a valid code from STARS Legacy Analysis Code System) |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions |
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 |
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 | Σ | 1..1 | Identifier | Business Identifier for observation |
basedOn | Σ | 0..1 | Reference(CSIRO STARS ServiceRequest Profile) | Fulfills plan, proposal or order |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: STARS Analysis Value Set (required) |
effective[x] | Σ | 0..1 | instant | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this version was made available |
value[x] | ΣC | 0..1 | Actual result | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueSampledData | SampledData | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
note | 0..1 | Annotation | Comments about the observation | |
specimen | 0..1 | Reference(CSIRO STARS Specimen Profile) | Specimen used for this observation | |
component | Σ | 0..* | BackboneElement | Component results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
value[x] | Σ | 0..1 | Actual component result | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueSampledData | SampledData | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.code | required | AnalysisValueSet (a valid code from STARS Legacy Analysis Code System) |
Observation.dataAbsentReason | extensible | DataAbsentReason |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
This structure is derived from Observation
Other representations of profile: CSV, Excel, Schematron