Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabObservationDefinition | Version: current | |||
Draft as of 2023-01-08 | Computable Name: LabObservationDefinition |
This profile constrains the base resource ObservationDefinition when referenced by ActivityDefinition.observationResultRequirement in the context of a catalog of laboratory services. Such a resource specifies the form of an output observation produced by a laboratory service.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ObservationDefinition
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | ObservationDefinition | Definition of an observation | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() | S | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period |
![]() ![]() ![]() | S | 0..1 | boolean | Multiple results allowed for conforming observations |
![]() ![]() ![]() | S | 0..1 | BackboneElement | Characteristics of quantitative results |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Primary unit for quantitative results |
![]() ![]() ![]() ![]() ![]() | 0..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Fixed Value: http://unitsofmeasure.org | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | ObservationDefinition | Definition of an observation |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes identifying the state of an ObservationDefinition. |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of observation Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
![]() ![]() ![]() | S | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept |
![]() ![]() ![]() | S | 0..1 | boolean | Multiple results allowed for conforming observations Example General: true |
![]() ![]() ![]() | S | 0..1 | BackboneElement | Characteristics of quantitative results |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Primary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://unitsofmeasure.org |
![]() |
Path | Conformance | ValueSet |
ObservationDefinition.status | required | PublicationStatus |
ObservationDefinition.code | example | LOINCCodes (a valid code from LOINC) |
ObservationDefinition.permittedDataType | required | ObservationDataType |
ObservationDefinition.quantitativeDetails.unit | extensible | UCUMCodes (a valid code from UCUM) |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ObservationDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}') | |
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() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | C | 0..* | ObservationDefinition | Definition of an observation | ||||
![]() ![]() ![]() | Σ | 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: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() | 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..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) | ||||
![]() ![]() ![]() | Σ | 0..1 | Identifier | Business identifier of the ObservationDefinition | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Business version of the ObservationDefinition | ||||
![]() ![]() ![]() | ΣC | 0..1 | string | Name for this ObservationDefinition (computer friendly) | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Name for this ObservationDefinition (human friendly) | ||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes identifying the state of an ObservationDefinition. | ||||
![]() ![]() ![]() | Σ | 0..1 | boolean | If for testing purposes, not real usage | ||||
![]() ![]() ![]() | Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The name of the individual or organization that published the ObservationDefinition | ||||
![]() ![]() ![]() | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() | 0..1 | markdown | Natural language description of the ObservationDefinition | |||||
![]() ![]() ![]() | Σ | 0..* | UsageContext | Content intends to support these contexts | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Intended jurisdiction for this ObservationDefinition (if applicable) Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used. | ||||
![]() ![]() ![]() | 0..1 | markdown | Why this ObservationDefinition is defined | |||||
![]() ![]() ![]() | 0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() | 0..1 | date | When ObservationDefinition was approved by publisher | |||||
![]() ![]() ![]() | 0..1 | date | Date on which the asset content was last reviewed | |||||
![]() ![]() ![]() | Σ | 0..1 | Period | The effective date range for the ObservationDefinition | ||||
![]() ![]() ![]() | Σ | 0..* | canonical(ObservationDefinition) | Based on FHIR definition of another observation | ||||
![]() ![]() ![]() | Σ | 0..* | uri | Based on external definition | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Type of subject for the defined observation | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Desired kind of performer for such kind of observation | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | General type of observation Binding: ObservationCategoryCodes (example): Codes for high level observation categories. | ||||
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of observation 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 Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | 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 Fixed Value: http://loinc.org | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | ||||
![]() ![]() ![]() | S | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept | ||||
![]() ![]() ![]() | S | 0..1 | boolean | Multiple results allowed for conforming observations Example General: true | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Body part to be observed Binding: SNOMEDCTBodyStructures (example): SNOMED CT body structures. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example): Methods for simple observations. | |||||
![]() ![]() ![]() | 0..* | Reference(SpecimenDefinition) | Kind of specimen used by this type of observation | |||||
![]() ![]() ![]() | 0..* | Reference(DeviceDefinition | Device) | Measurement device or model of device | |||||
![]() ![]() ![]() | 0..1 | string | The preferred name to be used when reporting the observation results | |||||
![]() ![]() ![]() | S | 0..1 | BackboneElement | Characteristics of quantitative 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 | ||||
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Primary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | ||||
![]() ![]() ![]() ![]() ![]() | 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 Fixed Value: http://unitsofmeasure.org | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Customary (secondary) unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | |||||
![]() ![]() ![]() ![]() | 0..1 | decimal | Primary to secondary unit conversion factor | |||||
![]() ![]() ![]() ![]() | 0..1 | integer | Decimal precision of observation quantitative results | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Set of qualified values for observation 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Context qualifier for the set of qualified values Binding: ObservationReferenceRangeMeaningCodes (extensible) | |||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Targetted population for the set of qualified values Binding: ObservationReferenceRangeAppliesToCodes (example) | |||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) Example General: female | |||||
![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range for the set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | Range | Applicable gestational age range for the set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Condition associated with the set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | code | reference | critical | absolute Binding: ObservationRangeCategory (required) Example General: critical | |||||
![]() ![]() ![]() ![]() | 0..1 | Range | The range for continuous or ordinal observations | |||||
![]() ![]() ![]() ![]() | 0..1 | canonical(ValueSet) | Value set of valid coded values as part of this set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | canonical(ValueSet) | Value set of normal coded values as part of this set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | canonical(ValueSet) | Value set of abnormal coded values as part of this set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | canonical(ValueSet) | Value set of critical coded values as part of this set of qualified values | |||||
![]() ![]() ![]() | 0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |||||
![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Type of observation Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
![]() ![]() ![]() ![]() | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept | |||||
![]() ![]() ![]() ![]() | 0..1 | See quantitativeDetails (ObservationDefinition) | Characteristics of quantitative results | |||||
![]() ![]() ![]() ![]() | 0..* | See qualifiedValue (ObservationDefinition) | Set of qualified values for observation results | |||||
![]() |
Path | Conformance | ValueSet | ||||
ObservationDefinition.language | preferred | CommonLanguages
| ||||
ObservationDefinition.status | required | PublicationStatus | ||||
ObservationDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
ObservationDefinition.category | example | ObservationCategoryCodes | ||||
ObservationDefinition.code | example | LOINCCodes (a valid code from LOINC) | ||||
ObservationDefinition.permittedDataType | required | ObservationDataType | ||||
ObservationDefinition.bodySite | example | SNOMEDCTBodyStructures | ||||
ObservationDefinition.method | example | ObservationMethods | ||||
ObservationDefinition.quantitativeDetails.unit | extensible | UCUMCodes (a valid code from UCUM) | ||||
ObservationDefinition.quantitativeDetails.customaryUnit | extensible | UCUMCodes (a valid code from UCUM) | ||||
ObservationDefinition.qualifiedValue.context | extensible | ObservationReferenceRangeMeaningCodes | ||||
ObservationDefinition.qualifiedValue.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
ObservationDefinition.qualifiedValue.gender | required | AdministrativeGender | ||||
ObservationDefinition.qualifiedValue.rangeCategory | required | ObservationRangeCategory | ||||
ObservationDefinition.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
ObservationDefinition.component.permittedDataType | required | ObservationDataType |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from ObservationDefinition
Summary
Must-Support: 4 elements
Fixed Value: 2 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ObservationDefinition
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | ObservationDefinition | Definition of an observation | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() | S | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period |
![]() ![]() ![]() | S | 0..1 | boolean | Multiple results allowed for conforming observations |
![]() ![]() ![]() | S | 0..1 | BackboneElement | Characteristics of quantitative results |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Primary unit for quantitative results |
![]() ![]() ![]() ![]() ![]() | 0..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Fixed Value: http://unitsofmeasure.org | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | ObservationDefinition | Definition of an observation |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes identifying the state of an ObservationDefinition. |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of observation Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
![]() ![]() ![]() | S | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept |
![]() ![]() ![]() | S | 0..1 | boolean | Multiple results allowed for conforming observations Example General: true |
![]() ![]() ![]() | S | 0..1 | BackboneElement | Characteristics of quantitative results |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Primary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://unitsofmeasure.org |
![]() |
Path | Conformance | ValueSet |
ObservationDefinition.status | required | PublicationStatus |
ObservationDefinition.code | example | LOINCCodes (a valid code from LOINC) |
ObservationDefinition.permittedDataType | required | ObservationDataType |
ObservationDefinition.quantitativeDetails.unit | extensible | UCUMCodes (a valid code from UCUM) |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ObservationDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}') | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | C | 0..* | ObservationDefinition | Definition of an observation | ||||
![]() ![]() ![]() | Σ | 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: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() | 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..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) | ||||
![]() ![]() ![]() | Σ | 0..1 | Identifier | Business identifier of the ObservationDefinition | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Business version of the ObservationDefinition | ||||
![]() ![]() ![]() | ΣC | 0..1 | string | Name for this ObservationDefinition (computer friendly) | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Name for this ObservationDefinition (human friendly) | ||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes identifying the state of an ObservationDefinition. | ||||
![]() ![]() ![]() | Σ | 0..1 | boolean | If for testing purposes, not real usage | ||||
![]() ![]() ![]() | Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The name of the individual or organization that published the ObservationDefinition | ||||
![]() ![]() ![]() | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() | 0..1 | markdown | Natural language description of the ObservationDefinition | |||||
![]() ![]() ![]() | Σ | 0..* | UsageContext | Content intends to support these contexts | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Intended jurisdiction for this ObservationDefinition (if applicable) Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used. | ||||
![]() ![]() ![]() | 0..1 | markdown | Why this ObservationDefinition is defined | |||||
![]() ![]() ![]() | 0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() | 0..1 | date | When ObservationDefinition was approved by publisher | |||||
![]() ![]() ![]() | 0..1 | date | Date on which the asset content was last reviewed | |||||
![]() ![]() ![]() | Σ | 0..1 | Period | The effective date range for the ObservationDefinition | ||||
![]() ![]() ![]() | Σ | 0..* | canonical(ObservationDefinition) | Based on FHIR definition of another observation | ||||
![]() ![]() ![]() | Σ | 0..* | uri | Based on external definition | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Type of subject for the defined observation | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Desired kind of performer for such kind of observation | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | General type of observation Binding: ObservationCategoryCodes (example): Codes for high level observation categories. | ||||
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Type of observation 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 Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | 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 Fixed Value: http://loinc.org | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | ||||
![]() ![]() ![]() | S | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept | ||||
![]() ![]() ![]() | S | 0..1 | boolean | Multiple results allowed for conforming observations Example General: true | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Body part to be observed Binding: SNOMEDCTBodyStructures (example): SNOMED CT body structures. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example): Methods for simple observations. | |||||
![]() ![]() ![]() | 0..* | Reference(SpecimenDefinition) | Kind of specimen used by this type of observation | |||||
![]() ![]() ![]() | 0..* | Reference(DeviceDefinition | Device) | Measurement device or model of device | |||||
![]() ![]() ![]() | 0..1 | string | The preferred name to be used when reporting the observation results | |||||
![]() ![]() ![]() | S | 0..1 | BackboneElement | Characteristics of quantitative 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 | ||||
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Primary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | ||||
![]() ![]() ![]() ![]() ![]() | 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 Fixed Value: http://unitsofmeasure.org | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Customary (secondary) unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | |||||
![]() ![]() ![]() ![]() | 0..1 | decimal | Primary to secondary unit conversion factor | |||||
![]() ![]() ![]() ![]() | 0..1 | integer | Decimal precision of observation quantitative results | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Set of qualified values for observation 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Context qualifier for the set of qualified values Binding: ObservationReferenceRangeMeaningCodes (extensible) | |||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Targetted population for the set of qualified values Binding: ObservationReferenceRangeAppliesToCodes (example) | |||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) Example General: female | |||||
![]() ![]() ![]() ![]() | 0..1 | Range | Applicable age range for the set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | Range | Applicable gestational age range for the set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Condition associated with the set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | code | reference | critical | absolute Binding: ObservationRangeCategory (required) Example General: critical | |||||
![]() ![]() ![]() ![]() | 0..1 | Range | The range for continuous or ordinal observations | |||||
![]() ![]() ![]() ![]() | 0..1 | canonical(ValueSet) | Value set of valid coded values as part of this set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | canonical(ValueSet) | Value set of normal coded values as part of this set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | canonical(ValueSet) | Value set of abnormal coded values as part of this set of qualified values | |||||
![]() ![]() ![]() ![]() | 0..1 | canonical(ValueSet) | Value set of critical coded values as part of this set of qualified values | |||||
![]() ![]() ![]() | 0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | |||||
![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Type of observation Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
![]() ![]() ![]() ![]() | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept | |||||
![]() ![]() ![]() ![]() | 0..1 | See quantitativeDetails (ObservationDefinition) | Characteristics of quantitative results | |||||
![]() ![]() ![]() ![]() | 0..* | See qualifiedValue (ObservationDefinition) | Set of qualified values for observation results | |||||
![]() |
Path | Conformance | ValueSet | ||||
ObservationDefinition.language | preferred | CommonLanguages
| ||||
ObservationDefinition.status | required | PublicationStatus | ||||
ObservationDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
ObservationDefinition.category | example | ObservationCategoryCodes | ||||
ObservationDefinition.code | example | LOINCCodes (a valid code from LOINC) | ||||
ObservationDefinition.permittedDataType | required | ObservationDataType | ||||
ObservationDefinition.bodySite | example | SNOMEDCTBodyStructures | ||||
ObservationDefinition.method | example | ObservationMethods | ||||
ObservationDefinition.quantitativeDetails.unit | extensible | UCUMCodes (a valid code from UCUM) | ||||
ObservationDefinition.quantitativeDetails.customaryUnit | extensible | UCUMCodes (a valid code from UCUM) | ||||
ObservationDefinition.qualifiedValue.context | extensible | ObservationReferenceRangeMeaningCodes | ||||
ObservationDefinition.qualifiedValue.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
ObservationDefinition.qualifiedValue.gender | required | AdministrativeGender | ||||
ObservationDefinition.qualifiedValue.rangeCategory | required | ObservationRangeCategory | ||||
ObservationDefinition.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
ObservationDefinition.component.permittedDataType | required | ObservationDataType |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from ObservationDefinition
Summary
Must-Support: 4 elements
Fixed Value: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron