This page is part of the SMART Health Cards Vaccination and Testing, Release 1 | STU 1 (v0.6.2: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-covid19-laboratory-result-observation-ad |
Version: | 0.6.2 |
Name: | SHCCovid19LaboratoryResultObservationAD |
Title: | COVID-19 Laboratory Result Observation Profile - Allowable Data |
Status: | Active as of 2021-08-13T13:26:56+00:00 |
Definition: | Profile for reporting COVID-19-related laboratory results indicating current or previous infection status. |
Publisher: | HL7 International - Public Health Work Group |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-covid19-laboratory-result-observation-ad
For representing laboratory test results related to infection with or immunity to an infectious disease.
Implementation instructions ← Start here!
Primary profile (DM) | Fallback Profiles (AD) | Scope |
---|---|---|
Lab results - COVID-19 | Fallback | COVID-19 only |
Lab results - Generic | Fallback | Other infectious diseases |
Note! This is a fallback “allowable data” (AD) profile. Implementers should validate against the primary “data minimization” (DM) profile if possible.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Summary
Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 9 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
id | 0..1 | string | Should not be populated | |
meta | ||||
security | S | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) |
status | SI | 1..1 | code | registered | preliminary | final | amended + vc-observation-status-shall-be-complete: SHALL be `final`, `amended`, or `corrected` |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LIVD SARS CoV2 Test Codes (required) |
subject | S | 1..1 | Reference(Patient Profile - General - Allowable Data) | Patient to whom lab result applies |
reference | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. | |
type | 0..0 | |||
identifier | 0..0 | |||
display | 0..0 | |||
effective[x] | S | 1..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
performer | S | 0..1 | Reference(Organization) | Organization which was responsible for the laboratory test result. |
display | SI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. |
Slices for value[x] | S | 1..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueCodeableConcept | 0..1 | CodeableConcept | Actual result Binding: Qualitative lab result findings (required) | |
valueQuantity | I | 0..1 | Quantity | Actual result vc-observation-quantity-should-have-range: Quantitative lab results SHOULD include reference range |
valueString | I | 0..1 | string | String representation of results; used ONLY when a computable representation is not possible vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. |
referenceRange | SI | 0..* | BackboneElement | Provides guide for interpretation. SHOULD include if using valueQuantity. vc-observation-range-only-quantity-or-string: Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions |
id | Σ | 0..1 | string | Should not be populated |
meta | Σ | 0..1 | Meta | Metadata about the resource |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
security | SΣ | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
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) Max Binding: AllLanguages: 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 | Σ | 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ΣI | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. vc-observation-status-shall-be-complete: SHALL be `final`, `amended`, or `corrected` |
category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LIVD SARS CoV2 Test Codes (required) |
subject | SΣ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Patient to whom lab result applies |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. |
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Σ | 1..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
issued | Σ | 0..1 | instant | Date/Time this version was made available |
performer | SΣ | 0..1 | Reference(Organization) | Organization which was responsible for the laboratory test result. |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 0..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 | SΣI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. |
Slices for value[x] | SΣI | 1..1 | Actual result Slice: Unordered, Closed by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
value[x]:valueCodeableConcept | ΣI | 0..1 | CodeableConcept | Actual result Binding: Qualitative lab result findings (required) |
value[x]:valueQuantity | ΣI | 0..1 | Quantity | Actual result vc-observation-quantity-should-have-range: Quantitative lab results SHOULD include reference range |
value[x]:valueString | ΣI | 0..1 | string | String representation of results; used ONLY when a computable representation is not possible vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
note | 0..* | Annotation | Comments about the observation | |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
referenceRange | SI | 0..* | BackboneElement | Provides guide for interpretation. SHOULD include if using valueQuantity. vc-observation-range-only-quantity-or-string: Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise |
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 | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
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 | I | 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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions |
meta | Σ | 0..1 | Meta | Metadata about the resource |
security | Σ | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) |
status | ?!ΣI | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. vc-observation-status-shall-be-complete: SHALL be `final`, `amended`, or `corrected` |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LIVD SARS CoV2 Test Codes (required) |
subject | Σ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Patient to whom lab result applies |
effective[x] | Σ | 1..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
performer | Σ | 0..1 | Reference(Organization) | Organization which was responsible for the laboratory test result. |
display | ΣI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. |
Slices for value[x] | ΣI | 1..1 | Actual result Slice: Unordered, Closed by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation. SHOULD include if using valueQuantity. vc-observation-range-only-quantity-or-string: Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise |
Documentation for this format |
This structure is derived from Observation
Summary
Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 9 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
id | 0..1 | string | Should not be populated | |
meta | ||||
security | S | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) |
status | SI | 1..1 | code | registered | preliminary | final | amended + vc-observation-status-shall-be-complete: SHALL be `final`, `amended`, or `corrected` |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LIVD SARS CoV2 Test Codes (required) |
subject | S | 1..1 | Reference(Patient Profile - General - Allowable Data) | Patient to whom lab result applies |
reference | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. | |
type | 0..0 | |||
identifier | 0..0 | |||
display | 0..0 | |||
effective[x] | S | 1..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
performer | S | 0..1 | Reference(Organization) | Organization which was responsible for the laboratory test result. |
display | SI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. |
Slices for value[x] | S | 1..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueCodeableConcept | 0..1 | CodeableConcept | Actual result Binding: Qualitative lab result findings (required) | |
valueQuantity | I | 0..1 | Quantity | Actual result vc-observation-quantity-should-have-range: Quantitative lab results SHOULD include reference range |
valueString | I | 0..1 | string | String representation of results; used ONLY when a computable representation is not possible vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. |
referenceRange | SI | 0..* | BackboneElement | Provides guide for interpretation. SHOULD include if using valueQuantity. vc-observation-range-only-quantity-or-string: Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions |
id | Σ | 0..1 | string | Should not be populated |
meta | Σ | 0..1 | Meta | Metadata about the resource |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
security | SΣ | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
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) Max Binding: AllLanguages: 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 | Σ | 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ΣI | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. vc-observation-status-shall-be-complete: SHALL be `final`, `amended`, or `corrected` |
category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LIVD SARS CoV2 Test Codes (required) |
subject | SΣ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Patient to whom lab result applies |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. |
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Σ | 1..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
issued | Σ | 0..1 | instant | Date/Time this version was made available |
performer | SΣ | 0..1 | Reference(Organization) | Organization which was responsible for the laboratory test result. |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 0..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 | SΣI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. |
Slices for value[x] | SΣI | 1..1 | Actual result Slice: Unordered, Closed by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
value[x]:valueCodeableConcept | ΣI | 0..1 | CodeableConcept | Actual result Binding: Qualitative lab result findings (required) |
value[x]:valueQuantity | ΣI | 0..1 | Quantity | Actual result vc-observation-quantity-should-have-range: Quantitative lab results SHOULD include reference range |
value[x]:valueString | ΣI | 0..1 | string | String representation of results; used ONLY when a computable representation is not possible vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
note | 0..* | Annotation | Comments about the observation | |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
referenceRange | SI | 0..* | BackboneElement | Provides guide for interpretation. SHOULD include if using valueQuantity. vc-observation-range-only-quantity-or-string: Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise |
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 | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
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 | I | 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 |
Other representations of profile: CSV, Excel, Schematron
Id | Path | Details | Requirements |
dom-2 | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() | |
ele-1 | Observation.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.meta.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.meta.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.meta.versionId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.meta.lastUpdated | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.meta.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.meta.profile | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.meta.security | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.meta.tag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
vc-observation-status-shall-be-complete | Observation.status | SHALL be `final`, `amended`, or `corrected` : $this.lower() in ('final'|'amended'|'corrected') | |
ele-1 | Observation.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.subject.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.subject.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.subject.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.focus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.effective[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.issued | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.performer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.performer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.performer.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.performer.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.performer.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.performer.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
vc-should-be-under-30-chars | Observation.performer.display | Length SHOULD be <30 for data minimization. : $this.length() < 30 | |
ele-1 | Observation.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.value[x]:valueCodeableConcept | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.value[x]:valueQuantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
vc-observation-quantity-should-have-range | Observation.value[x]:valueQuantity | Quantitative lab results SHOULD include reference range : %resource.referenceRange.exists() | |
ele-1 | Observation.value[x]:valueString | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
vc-should-be-under-20-chars | Observation.value[x]:valueString | Length SHOULD be <20 for data minimization. : $this.length() < 20 | |
ele-1 | Observation.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.interpretation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.specimen | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.device | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
obs-3 | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
vc-observation-range-only-quantity-or-string | Observation.referenceRange | Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise : $this.exists() and (%resource.value.ofType(Quantity).exists() or %resource.value.ofType(String).exists()) | |
ele-1 | Observation.referenceRange.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.referenceRange.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.referenceRange.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.referenceRange.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.referenceRange.low | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.high | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.appliesTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.age | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.hasMember | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.derivedFrom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.interpretation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |