Order Catalog Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. 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/InputObservationDefinition | Version: 1.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: InputObservationDefinition | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.42.11 |
This profile constrains the base resource ObservationDefinition when referenced by ActivityDefinition.observationRequirement in the context of a catalog of laboratory services. Such a resource specifies the form of an input observation expected alongside the order of a laboratory service.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ObservationDefinition
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ObservationDefinition | Definition of an observation | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() ![]() |
0..* | 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 |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | ObservationDefinition | Definition of an observation Constraints: cnl-0, obd-0 |
![]() ![]() ![]() |
?!Σ | 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 | 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..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
![]() ![]() ![]() |
SC | 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 |
![]() |
Path | Conformance | ValueSet | URI |
ObservationDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 From the FHIR Standard | |
ObservationDefinition.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
ObservationDefinition.permittedDataType | required | ObservationDataTypehttp://hl7.org/fhir/ValueSet/permitted-data-type|5.0.0 From the FHIR Standard |
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() | |
obd-0 | error | ObservationDefinition | If permittedUnit exists, then permittedDataType=Quantity must exist. : permittedUnit.exists() implies (permittedDataType = 'Quantity').exists() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | ObservationDefinition | Definition of an observation Constraints: cnl-0, obd-0 | ||||
![]() ![]() ![]() |
Σ | 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..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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
Σ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 | string | 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: JurisdictionValueSet (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 | string | Copyright holder and year(s) | |||||
![]() ![]() ![]() |
0..1 | date | When ObservationDefinition was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | Date on which the asset content was last reviewed by the publisher | |||||
![]() ![]() ![]() |
Σ | 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..* | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ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 | ||||
![]() ![]() ![]() |
SC | 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 | 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 | |||||
![]() ![]() ![]() |
C | 0..* | Coding | Unit for quantitative results Binding: UCUMCodes (preferred): Codes identifying units of measure. | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Component results Constraints: obd-1 | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
C | 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 | ||||
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Unit for quantitative results Binding: UCUMCodes (preferred): Codes identifying units of measure. | ||||
![]() ![]() ![]() ![]() |
0..* | See qualifiedValue (ObservationDefinition) | Set of qualified values for observation results | |||||
![]() |
Path | Conformance | ValueSet | URI |
ObservationDefinition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
ObservationDefinition.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm From the FHIR Standard | |
ObservationDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 From the FHIR Standard | |
ObservationDefinition.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction From the FHIR Standard | |
ObservationDefinition.category | example | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard | |
ObservationDefinition.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
ObservationDefinition.permittedDataType | required | ObservationDataTypehttp://hl7.org/fhir/ValueSet/permitted-data-type|5.0.0 From the FHIR Standard | |
ObservationDefinition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard | |
ObservationDefinition.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods From the FHIR Standard | |
ObservationDefinition.permittedUnit | preferred | UCUMCodes(a valid code from UCUM)http://hl7.org/fhir/ValueSet/ucum-units From the FHIR Standard | |
ObservationDefinition.qualifiedValue.context | extensible | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning From the FHIR Standard | |
ObservationDefinition.qualifiedValue.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto From the FHIR Standard | |
ObservationDefinition.qualifiedValue.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 From the FHIR Standard | |
ObservationDefinition.qualifiedValue.rangeCategory | required | ObservationRangeCategoryhttp://hl7.org/fhir/ValueSet/observation-range-category|5.0.0 From the FHIR Standard | |
ObservationDefinition.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
ObservationDefinition.component.permittedDataType | required | ObservationDataTypehttp://hl7.org/fhir/ValueSet/permitted-data-type|5.0.0 From the FHIR Standard | |
ObservationDefinition.component.permittedUnit | preferred | UCUMCodes(a valid code from UCUM)http://hl7.org/fhir/ValueSet/ucum-units From the FHIR Standard |
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() | |
obd-0 | error | ObservationDefinition | If permittedUnit exists, then permittedDataType=Quantity must exist. : permittedUnit.exists() implies (permittedDataType = 'Quantity').exists() | |
obd-1 | error | ObservationDefinition.component | If permittedUnit exists, then permittedDataType=Quantity must exist. : permittedUnit.exists() implies (permittedDataType = 'Quantity').exists() |
This structure is derived from ObservationDefinition
Differential View
This structure is derived from ObservationDefinition
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ObservationDefinition | Definition of an observation | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() ![]() |
0..* | 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 |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | ObservationDefinition | Definition of an observation Constraints: cnl-0, obd-0 |
![]() ![]() ![]() |
?!Σ | 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 | 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..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
![]() ![]() ![]() |
SC | 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 |
![]() |
Path | Conformance | ValueSet | URI |
ObservationDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 From the FHIR Standard | |
ObservationDefinition.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
ObservationDefinition.permittedDataType | required | ObservationDataTypehttp://hl7.org/fhir/ValueSet/permitted-data-type|5.0.0 From the FHIR Standard |
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() | |
obd-0 | error | ObservationDefinition | If permittedUnit exists, then permittedDataType=Quantity must exist. : permittedUnit.exists() implies (permittedDataType = 'Quantity').exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | ObservationDefinition | Definition of an observation Constraints: cnl-0, obd-0 | ||||
![]() ![]() ![]() |
Σ | 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..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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
Σ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 | string | 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: JurisdictionValueSet (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 | string | Copyright holder and year(s) | |||||
![]() ![]() ![]() |
0..1 | date | When ObservationDefinition was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | Date on which the asset content was last reviewed by the publisher | |||||
![]() ![]() ![]() |
Σ | 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..* | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ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 | ||||
![]() ![]() ![]() |
SC | 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 | 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 | |||||
![]() ![]() ![]() |
C | 0..* | Coding | Unit for quantitative results Binding: UCUMCodes (preferred): Codes identifying units of measure. | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Component results Constraints: obd-1 | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
C | 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 | ||||
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Unit for quantitative results Binding: UCUMCodes (preferred): Codes identifying units of measure. | ||||
![]() ![]() ![]() ![]() |
0..* | See qualifiedValue (ObservationDefinition) | Set of qualified values for observation results | |||||
![]() |
Path | Conformance | ValueSet | URI |
ObservationDefinition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
ObservationDefinition.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm From the FHIR Standard | |
ObservationDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 From the FHIR Standard | |
ObservationDefinition.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction From the FHIR Standard | |
ObservationDefinition.category | example | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard | |
ObservationDefinition.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
ObservationDefinition.permittedDataType | required | ObservationDataTypehttp://hl7.org/fhir/ValueSet/permitted-data-type|5.0.0 From the FHIR Standard | |
ObservationDefinition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard | |
ObservationDefinition.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods From the FHIR Standard | |
ObservationDefinition.permittedUnit | preferred | UCUMCodes(a valid code from UCUM)http://hl7.org/fhir/ValueSet/ucum-units From the FHIR Standard | |
ObservationDefinition.qualifiedValue.context | extensible | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning From the FHIR Standard | |
ObservationDefinition.qualifiedValue.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto From the FHIR Standard | |
ObservationDefinition.qualifiedValue.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 From the FHIR Standard | |
ObservationDefinition.qualifiedValue.rangeCategory | required | ObservationRangeCategoryhttp://hl7.org/fhir/ValueSet/observation-range-category|5.0.0 From the FHIR Standard | |
ObservationDefinition.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
ObservationDefinition.component.permittedDataType | required | ObservationDataTypehttp://hl7.org/fhir/ValueSet/permitted-data-type|5.0.0 From the FHIR Standard | |
ObservationDefinition.component.permittedUnit | preferred | UCUMCodes(a valid code from UCUM)http://hl7.org/fhir/ValueSet/ucum-units From the FHIR Standard |
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() | |
obd-0 | error | ObservationDefinition | If permittedUnit exists, then permittedDataType=Quantity must exist. : permittedUnit.exists() implies (permittedDataType = 'Quantity').exists() | |
obd-1 | error | ObservationDefinition.component | If permittedUnit exists, then permittedDataType=Quantity must exist. : permittedUnit.exists() implies (permittedDataType = 'Quantity').exists() |
This structure is derived from ObservationDefinition
Other representations of profile: CSV, Excel, Schematron