Generated Narrative: StructureDefinition InputObservationDefinition Name Flags Card. Type Description & Constraints ObservationDefinition 0..* ObservationDefinition Definition of an observation #xD; code #xD; Slices for coding 0..* Coding Code defined by a terminology system Slice: Unordered, Open by value:system #xD; coding:LOINC 0..* Coding Code defined by a terminology system #xD; system 0..1 uri Identity of the terminology system Required Pattern: http://loinc.org #xD; permittedDataType S 0..* code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period #xD; Documentation for this format
HL7 International / Orders and Observations
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.
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.
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}$')
If permittedUnit exists, then permittedDataType=Quantity must exist.
permittedUnit.exists() implies (permittedDataType = 'Quantity').exists()
Observation[classCode=OBS, moodCode=DEF]
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Logical canonical URL to reference this ObservationDefinition (globally unique)
An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.
Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.
Allows the ObservationDefinition to be referenced by a single globally unique identifier.
Business identifier of the ObservationDefinition
Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.
Allows identification of the ObservationDefinition as it is known by various participating systems and in a way that remains consistent across servers.
Business version of the ObservationDefinition
The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.
There may be multiple different instances of an observationDefinition that have the same identifier but different versions.
Indicates the mechanism used to compare versions to determine which is more current.
If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
Name for this ObservationDefinition (computer friendly)
A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Support human navigation and code generation.
Name for this ObservationDefinition (human friendly)
A short, descriptive, user-friendly title for the ObservationDefinition.
The current state of the ObservationDefinition.
A nominal state-transition diagram can be found in the [Definition pattern](http://hl7.org/fhir/R5/definition.html#statemachine) documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
Not known why this is labelled a modifier
Codes identifying the state of an ObservationDefinition.
A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Allows filtering of ObservationDefinition that are appropriate for use vs. not.
If absent, this resource is treated as though it is not experimental.
The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes.
The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the ObservationDefinition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
The name of the individual or organization that published the ObservationDefinition
Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.
Usually an organization, but may be an individual. The publisher (or steward) of the ObservationDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the ObservationDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the ObservationDefinition. This item SHOULD be populated unless the information is available from context.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
Natural language description of the ObservationDefinition
A free text natural language description of the ObservationDefinition from the consumer's perspective.
This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.
Content intends to support these contexts
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances.
When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for this ObservationDefinition (if applicable)
A jurisdiction in which the ObservationDefinition is intended to be used.
It may be possible for the ObservationDefinition to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
Codes for country, country subdivision and region for indicating where a resource is intended to be used.
Why this ObservationDefinition is defined
Explains why this ObservationDefinition is needed and why it has been designed as it has.
This element does not describe the usage of the ObservationDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this ObservationDefinition.
Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.
Consumers of the ObservationDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content.
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
Defines the content expected to be rendered in all representations of the artifact.
When ObservationDefinition was approved by publisher
The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
The date may be more recent than the approval date because of minor changes / editorial corrections. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
Date on which the asset content was last reviewed by the publisher
The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
If specified, this is usually after the approval date. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
The effective date range for the ObservationDefinition
The period during which the ObservationDefinition content was or is planned to be effective.
The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation definition intended to be used for the year 2021 might be published in 2020. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
Based on FHIR definition of another observation
The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.
The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.
Observation definitions may be refinements of other definitions.
Type of subject for the defined observation
A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.
Examples: person, animal, device, air, surface ….
Desired kind of performer for such kind of observation
The type of individual/organization/device that is expected to act upon instances of this definition.
A code that classifies the general type of observation.
This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set.
Used for filtering what kinds of observations are retrieved and displayed.
Codes for high level observation categories.
.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="DEF"].code
Describes what will be observed. Sometimes this is called the observation "name".
Codes identifying names of simple observations.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
A reference to a code defined by a terminology system.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
The identification of the code system that defines the meaning of the symbol in the code.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Need to be unambiguous about the source of the definition of the symbol.
fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Need to refer to a particular code in the system.
fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
C*E.2 - but note this is not well followed
fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
If this coding was chosen directly by the user
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Plain text representation of the concept
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Very often the text is the same as a displayName of one of the codings.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
Permitted data type for observation value.
Multiple results allowed for conforming observations
Multiple results allowed for observations conforming to this ObservationDefinition.
An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result.
The site on the subject's body where the observation is to be made.
Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations. Example: 14975008 |Forearm structure|.
The method or technique used to perform the observation.
Only used if not implicit in observation code Example: 702659008 |Automated count technique|.
In some cases, method can impact results.
Kind of specimen used by this type of observation
The kind of specimen that this type of observation is produced on.
Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation.
The measurement model of device or actual device used to produce observations of this type.
When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation.
The preferred name to be used when reporting the observation results
The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition.
Set of qualified values for observation results
A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Context qualifier for the set of qualified values
A concept defining the context for this set of qualified values.
Targetted population for the set of qualified values
The target population this set of qualified values applies to.
If this element is not present then the global population is assumed.
The gender this set of qualified values applies to.
Applicable age range for the set of qualified values
The age range this set of qualified values applies to.
Applicable gestational age range for the set of qualified values
The gestational age this set of qualified values applies to.
Condition associated with the set of qualified values
Text based condition for which the the set of qualified values is valid.
The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values.
The range for continuous or ordinal observations
The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values.
The unit may be not relevant for ordinal values. In case it is there, it is the same as ObservationDefinition.unit.
Value set of valid coded values as part of this set of qualified values
The set of valid coded results for qualitative observations that match the criteria of this set of qualified values.
Value set of normal coded values as part of this set of qualified values
The set of normal coded results for qualitative observations that match the criteria of this set of qualified values.
Value set of abnormal coded values as part of this set of qualified values
The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values.
Value set of critical coded values as part of this set of qualified values
The set of critical coded results for qualitative observations that match the criteria of this set of qualified values.
Definitions of related resources belonging to this kind of observation group
This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
Some observations have multiple component observations, expressed as separate code value pairs.
Component observations share the same attributes as the primary observation and are always treated as a part of it (they are not separable).
The data types allowed for the value element of the instance of this component observations.