HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - STU1
HL7 FHIR Implementation Guide: Rwanda HIV, published by Jembi Health Systems. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/openhie/Rwanda-HIV and changes regularly. See the Directory of published versions
Official URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/viral-load-repeat-test-result | Version: 0.1.0 | |||
Active as of 2023-09-15 | Computable Name: RepeatHIVTestResult |
Represents the result of the repeat VL test.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Observation | Measurements and simple assertions | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 398579006 | |
![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: Viral Load Result | |
![]() ![]() ![]() | 1..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct) | Who and/or what the observation is about | |
![]() ![]() ![]() | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
![]() ![]() ![]() | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() | 1..1 | dateTime | Clinically relevant time/time-period for observation | |
![]() ![]() ![]() | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |
![]() ![]() ![]() | 1..1 | integer | Actual result Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() | 1..1 | integer | Actual result | |
![]() ![]() ![]() | S | 0..* | Annotation | Comments about the observation |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Observation | Measurements and simple assertions |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
![]() ![]() ![]() | ΣC | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Viral Load Result |
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct) | Who and/or what the observation is about |
![]() ![]() ![]() | Σ | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation |
![]() ![]() ![]() | Σ | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() | ΣC | 1..1 | integer | Actual result Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | ΣC | 1..1 | integer | Actual result |
![]() ![]() ![]() | S | 0..* | Annotation | Comments about the observation |
![]() |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.code | example | LOINCCodes (a valid code from LOINC) |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() | |
obs-8 | error | Observation | bodyStructure SHALL only be present if Observation.bodySite is not present : bodySite.exists() implies bodyStructure.empty() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Observation | Measurements and simple assertions |
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | Business Identifier for observation |
![]() ![]() ![]() | ΣTU | 0..1 | canonical(ObservationDefinition), Reference(ObservationDefinition) | Instantiates FHIR ObservationDefinition |
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() | TU | 0..* | BackboneElement | Triggering observation(s) |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Observation) | Triggering observation |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | reflex | repeat | re-run Binding: TriggeredBytype (required): The type of TriggeredBy Observation. |
![]() ![]() ![]() ![]() | 0..1 | string | Reason that the observation was triggered | |
![]() ![]() ![]() | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) | Part of referenced event |
![]() ![]() ![]() | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
![]() ![]() ![]() | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
![]() ![]() ![]() | ΣC | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 398579006 |
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Viral Load Result |
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct) | Who and/or what the observation is about |
![]() ![]() ![]() | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
![]() ![]() ![]() | Σ | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation |
![]() ![]() ![]() | Σ | 0..1 | instant | Date/Time this version was made available |
![]() ![]() ![]() | Σ | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() | ΣC | 1..1 | integer | Actual result Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | ΣC | 1..1 | integer | Actual result |
![]() ![]() ![]() | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() | 0..* | CodeableConcept | High, low, normal, etc Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() | S | 0..* | Annotation | Comments about the observation |
![]() ![]() ![]() | C | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
![]() ![]() ![]() | CTU | 0..1 | Reference(BodyStructure) | Observed body structure |
![]() ![]() ![]() | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
![]() ![]() ![]() | C | 0..1 | Reference(Specimen | Group) | Specimen used for this observation |
![]() ![]() ![]() | 0..1 | Reference(Device | DeviceMetric) | A reference to the device that generates the measurements or the device settings for the device | |
![]() ![]() ![]() | C | 0..* | BackboneElement | Provides guide for interpretation |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | C | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() | C | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() | TU | 0..1 | CodeableConcept | Normal value, if relevant Binding: ObservationReferenceRangeNormalValueCodes (extensible): Codes identifying the normal value of the observation. |
![]() ![]() ![]() ![]() | TU | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() | C | 0..1 | markdown | Text based reference range in an observation |
![]() ![]() ![]() | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
![]() ![]() ![]() | Σ | 0..* | Reference(DocumentReference | ImagingStudy | ImagingSelection | QuestionnaireResponse | Observation | MolecularSequence | GenomicStudy) | Related resource from which the observation is made |
![]() ![]() ![]() | ΣC | 0..* | BackboneElement | Component results |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | ΣC | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() | Σ | 0..1 | Actual component result | |
![]() ![]() ![]() ![]() ![]() | Quantity | |||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() ![]() | integer | |||
![]() ![]() ![]() ![]() ![]() | Range | |||
![]() ![]() ![]() ![]() ![]() | Ratio | |||
![]() ![]() ![]() ![]() ![]() | SampledData | |||
![]() ![]() ![]() ![]() ![]() | time | |||
![]() ![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() ![]() | Period | |||
![]() ![]() ![]() ![]() ![]() | Attachment | |||
![]() ![]() ![]() ![]() ![]() | Reference(MolecularSequence) | |||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | High, low, normal, etc Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() ![]() | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
![]() |
Path | Conformance | ValueSet |
Observation.language | required | AllLanguages |
Observation.triggeredBy.type | required | TriggeredBytype |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.code | example | LOINCCodes (a valid code from LOINC) |
Observation.dataAbsentReason | extensible | DataAbsentReason |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Observation.bodySite | example | SNOMEDCTBodyStructures |
Observation.method | example | ObservationMethods |
Observation.referenceRange.normalValue | extensible | ObservationReferenceRangeNormalValueCodes |
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 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() | |
obs-8 | error | Observation | bodyStructure SHALL only be present if Observation.bodySite is not present : bodySite.exists() implies bodyStructure.empty() | |
obs-9 | error | Observation.specimen | If Observation.specimen is a reference to Group, the group can only have specimens : (reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen) |
This structure is derived from Observation
Summary
Mandatory: 7 elements
Must-Support: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Observation | Measurements and simple assertions | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 398579006 | |
![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: Viral Load Result | |
![]() ![]() ![]() | 1..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct) | Who and/or what the observation is about | |
![]() ![]() ![]() | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
![]() ![]() ![]() | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() | 1..1 | dateTime | Clinically relevant time/time-period for observation | |
![]() ![]() ![]() | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |
![]() ![]() ![]() | 1..1 | integer | Actual result Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() | 1..1 | integer | Actual result | |
![]() ![]() ![]() | S | 0..* | Annotation | Comments about the observation |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Observation | Measurements and simple assertions |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
![]() ![]() ![]() | ΣC | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Viral Load Result |
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct) | Who and/or what the observation is about |
![]() ![]() ![]() | Σ | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation |
![]() ![]() ![]() | Σ | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() | ΣC | 1..1 | integer | Actual result Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | ΣC | 1..1 | integer | Actual result |
![]() ![]() ![]() | S | 0..* | Annotation | Comments about the observation |
![]() |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.code | example | LOINCCodes (a valid code from LOINC) |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() | |
obs-8 | error | Observation | bodyStructure SHALL only be present if Observation.bodySite is not present : bodySite.exists() implies bodyStructure.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Observation | Measurements and simple assertions |
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | Business Identifier for observation |
![]() ![]() ![]() | ΣTU | 0..1 | canonical(ObservationDefinition), Reference(ObservationDefinition) | Instantiates FHIR ObservationDefinition |
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() | TU | 0..* | BackboneElement | Triggering observation(s) |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Observation) | Triggering observation |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | reflex | repeat | re-run Binding: TriggeredBytype (required): The type of TriggeredBy Observation. |
![]() ![]() ![]() ![]() | 0..1 | string | Reason that the observation was triggered | |
![]() ![]() ![]() | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) | Part of referenced event |
![]() ![]() ![]() | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
![]() ![]() ![]() | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
![]() ![]() ![]() | ΣC | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 398579006 |
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Viral Load Result |
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct) | Who and/or what the observation is about |
![]() ![]() ![]() | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
![]() ![]() ![]() | Σ | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation |
![]() ![]() ![]() | Σ | 0..1 | instant | Date/Time this version was made available |
![]() ![]() ![]() | Σ | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() | ΣC | 1..1 | integer | Actual result Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | ΣC | 1..1 | integer | Actual result |
![]() ![]() ![]() | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() | 0..* | CodeableConcept | High, low, normal, etc Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() | S | 0..* | Annotation | Comments about the observation |
![]() ![]() ![]() | C | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
![]() ![]() ![]() | CTU | 0..1 | Reference(BodyStructure) | Observed body structure |
![]() ![]() ![]() | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
![]() ![]() ![]() | C | 0..1 | Reference(Specimen | Group) | Specimen used for this observation |
![]() ![]() ![]() | 0..1 | Reference(Device | DeviceMetric) | A reference to the device that generates the measurements or the device settings for the device | |
![]() ![]() ![]() | C | 0..* | BackboneElement | Provides guide for interpretation |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | C | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() | C | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() | TU | 0..1 | CodeableConcept | Normal value, if relevant Binding: ObservationReferenceRangeNormalValueCodes (extensible): Codes identifying the normal value of the observation. |
![]() ![]() ![]() ![]() | TU | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() | C | 0..1 | markdown | Text based reference range in an observation |
![]() ![]() ![]() | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
![]() ![]() ![]() | Σ | 0..* | Reference(DocumentReference | ImagingStudy | ImagingSelection | QuestionnaireResponse | Observation | MolecularSequence | GenomicStudy) | Related resource from which the observation is made |
![]() ![]() ![]() | ΣC | 0..* | BackboneElement | Component results |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | ΣC | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() | Σ | 0..1 | Actual component result | |
![]() ![]() ![]() ![]() ![]() | Quantity | |||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() ![]() | integer | |||
![]() ![]() ![]() ![]() ![]() | Range | |||
![]() ![]() ![]() ![]() ![]() | Ratio | |||
![]() ![]() ![]() ![]() ![]() | SampledData | |||
![]() ![]() ![]() ![]() ![]() | time | |||
![]() ![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() ![]() | Period | |||
![]() ![]() ![]() ![]() ![]() | Attachment | |||
![]() ![]() ![]() ![]() ![]() | Reference(MolecularSequence) | |||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | High, low, normal, etc Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() ![]() | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
![]() |
Path | Conformance | ValueSet |
Observation.language | required | AllLanguages |
Observation.triggeredBy.type | required | TriggeredBytype |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.code | example | LOINCCodes (a valid code from LOINC) |
Observation.dataAbsentReason | extensible | DataAbsentReason |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Observation.bodySite | example | SNOMEDCTBodyStructures |
Observation.method | example | ObservationMethods |
Observation.referenceRange.normalValue | extensible | ObservationReferenceRangeNormalValueCodes |
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 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() | |
obs-8 | error | Observation | bodyStructure SHALL only be present if Observation.bodySite is not present : bodySite.exists() implies bodyStructure.empty() | |
obs-9 | error | Observation.specimen | If Observation.specimen is a reference to Group, the group can only have specimens : (reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen) |
This structure is derived from Observation
Summary
Mandatory: 7 elements
Must-Support: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron