Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Operation-composition-document.ttl Compartments : Device , Encounter , Patient
FHIR Infrastructure icon Structured Documents Work Group Maturity Level : N/A Standards Status : Informative

This page provides mappings for Element Definition (see Mappings to Other Standards for further information & status).

Many other standard frameworks define frameworks for defining "data elements". These overlap to some degree with the ElementDefinition type. This page provides general mappings between ElementDefinition and the other frameworks. One important consideration with regard to other Element definition frameworks is the scope of the definition. Many of these definition frameworks use the term "Data Element" to refer to a data item that is collected and stored with provenance, such as when it was collected, who recorded it, etc. In this specification, that's an Observation , Practitioner and the definition of this kind of data element is an ObservationDefinition , RelatedPerson or a StructureDefinition that contains several different atomic data items. An ElementDefinition in this specification is a narrower notion, solely around the characteristics of a single element, it's definition, and it's value domain icon . Other frameworks - especially ISO 11179 - are used in both ways, sometimes with no formal differentiation between them. For this reason, the mappings on this page are very provisional, and are provided with the intent of helping implementers understand the possible relationships.

On this page:

v2 Mappings to the V2 segment OM1 which is used to define observations (i.e. also related to ObservationDefinition )
Raw Turtle RIM (+ Mappings to the RIM class Observation in definition mood which is used to define observations (i.e. also see Turtle/RDF Format Specification related to ObservationDefinition ) Operation Definition @prefix fhir: <http://hl7.org/fhir/> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . # - resource ------------------------------------------------------------------- [] a fhir:OperationDefinition; fhir:Resource.id [ fhir:value "Composition-document"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ] ]; fhir:DomainResource.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ]; fhir:Extension.value [ fhir:value "2" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "trial-use" ] ]; fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/Composition-document"]; fhir:OperationDefinition.version [ fhir:value "4.0.1"]; fhir:OperationDefinition.name [ fhir:value "Generate a Document"]; fhir:OperationDefinition.status [ fhir:value "draft"]; fhir:OperationDefinition.kind [ fhir:value "operation"]; fhir:OperationDefinition.date [ fhir:value "2019-11-01T09:29:23+11:00"]; fhir:OperationDefinition.publisher [ fhir:value "HL7 (FHIR Project)"]; fhir:OperationDefinition.contact [ fhir:index 0; fhir:ContactDetail.telecom [ fhir:index 0; fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ], [ fhir:index 1; fhir:ContactPoint.system [ fhir:value "email" ]; fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ] ] ]; fhir:OperationDefinition.description [ fhir:value "A client can ask a server to generate a fully bundled document from a composition resource. The server takes the composition resource, locates all the referenced resources and other additional resources as configured or requested and either returns a full document bundle, or returns an error. Note that since this is a search operation, the document bundle is wrapped inside the search bundle. If some of the resources are located on other servers, it is at the discretion of the server whether to retrieve them or return an error. If the correct version of the document that would be generated already exists, then the server can return the existing one."]; fhir:OperationDefinition.code [ fhir:value "document"]; fhir:OperationDefinition.comment [ fhir:value "Note: this operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question"]; fhir:OperationDefinition.resource [ fhir:value "Composition"; fhir:index 0 ]; fhir:OperationDefinition.system [ fhir:value "false"]; fhir:OperationDefinition.type [ fhir:value "true"]; fhir:OperationDefinition.instance [ fhir:value "true"]; fhir:OperationDefinition.parameter [ fhir:index 0; fhir:OperationDefinition.name [ fhir:value "id" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "Identifies the composition to use. This can either be a simple id, which identifies a composition, or it can be a full URL, which identifies a composition on another server. \n\nNotes: \n\n* GET [base]/Composition/[id]/$document is identical in meaning to GET [base]/Composition/$document?id=[id]\n* the id parameter SHALL NOT be used if the operation is requested on a particular composition (e.g. GET [base]/Composition/[id]/$document?id=[id] is not allowed)\n* Servers are not required to support generating documents on Compositions located on another server" ]; fhir:OperationDefinition.type [ fhir:value "uri" ] ], [ fhir:index 1; fhir:OperationDefinition.name [ fhir:value "persist" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "Whether to store the document at the bundle end-point (/Bundle) or not once it is generated. Value = true or false (default is for the server to decide). If the document is stored, it's location can be inferred from the Bundle.id, but it SHOULD be provided explicitly in the HTTP Location header in the response" ]; fhir:OperationDefinition.type [ fhir:value "boolean" ] ], [ fhir:index 2; fhir:OperationDefinition.name [ fhir:value "graph" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources" ]; fhir:OperationDefinition.type [ fhir:value "uri" ] ] . # ------------------------------------------------------------------------------------- Usage note: every effort has been made
IHE DEX Mappings IHE Data Element Exchange, which is closer to ensure defining atomic data elements - still very incomplete
LOINC Mappings to the LOINC master table which defines observations - this may be relevant when the element describes an observable piece of data. This is particularly relevant in profiles of observation, and also related to ObservationDefinition
ISO 11179 Mappings to ISO 11179 which details how the ElementDefinition class relates to the ISO 11179 framework. Note that the examples principle differences are correct that FHIR does not differentiate between a Data Element and useful, but they a Data Element Value, and the FHIR specification is heavily type dependent. Also, the FHIR specification includes constraints and other concerns that are not outside the scope of ISO 11179
ElementDefinition OM1
    path N/A
    representation N/A
    sliceName N/A
    sliceIsConstraining N/A
    label
    code OM1.7
    slicing
        discriminator
            type
            path
        description
        ordered
        rules
    short
    definition OM1.6, OM1.41
    comment NTE, OM1.32, OM1.33, OM1.39
    requirements
    alias OM1.8, OM1.52
    min
    max OMC.10
    base
        path
        min
        max
    contentReference
    type OM1.3, OMC.9
        code OM1.3
        profile
        targetProfile
        aggregation
        versioning
    defaultValue[x]
    meaningWhenMissing
    orderMeaning
    fixed[x]
    pattern[x]
    example
        label
        value[x]
    minValue[x]
    maxValue[x]
    maxLength OMC.12
    condition
    constraint
        key
        requirements
        severity
        suppress
        human
        expression
        xpath
        source
    mustSupport
    isModifier
    isModifierReason
    isSummary
    binding OM3, OMC.11
        strength N/A
        description
        valueSet
    mapping
        identity
        language
        map
        comment
ElementDefinition Observation[classCode=OBS, moodCode=DEFN]
    path N/A
    representation N/A
    sliceName N/A
    sliceIsConstraining N/A
    label ./code/display
    code ./code (root or translation)
    slicing N/A
        discriminator N/A
            type N/A
            path N/A
        description N/A
        ordered N/A
        rules N/A
    short N/A
    definition ./text
    comment ./inboundRelationship[typeCode=SUBJ]/source[classCode=LIST, moodCode=EVN]/code
    requirements ./inboundRelationship[typeCode=META]/source[classCode=ACT, moodCode=EVN, isCriterionInd=true]/reasonCode/originalText
    alias Not currently expressible
    min N/A (MIF territory)
    max N/A (MIF territory)
    base N/A (MIF territory)
        path N/A (MIF territory)
        min N/A (MIF territory)
        max N/A (MIF territory)
    contentReference N/A
    type N/A (MIF territory)
        code N/A (MIF territory)
        profile N/A (MIF territory)
        targetProfile N/A (MIF territory)
        aggregation N/A (MIF territory)
        versioning N/A (MIF territory)
    defaultValue[x] N/A (MIF territory)
    meaningWhenMissing N/A (MIF territory)
    orderMeaning N/A (MIF territory)
    fixed[x] N/A (MIF territory)
    pattern[x] N/A (MIF territory)
    example N/A (MIF territory)
        label N/A (MIF territory)
        value[x] N/A (MIF territory)
    minValue[x] N/A (MIF territory)
    maxValue[x] N/A (MIF territory)
    maxLength N/A (MIF territory)
    condition N/A (MIF territory)
    constraint N/A (MIF territory)
        key N/A (MIF territory)
        requirements N/A (MIF territory)
        severity N/A (MIF territory)
        suppress N/A (MIF territory)
        human N/A (MIF territory)
        expression N/A (MIF territory)
        xpath N/A (MIF territory)
        source N/A (MIF territory)
    mustSupport N/A (MIF territory)
    isModifier N/A (MIF territory)
    isModifierReason N/A (MIF territory)
    isSummary N/A (MIF territory)
    binding N/A (MIF territory)
        strength N/A (MIF territory)
        description N/A (MIF territory)
        valueSet N/A (MIF territory)
    mapping N/A (MIF territory)
        identity N/A (MIF territory)
        language N/A (MIF territory)
        map N/A (MIF territory)
        comment N/A (MIF territory)
ElementDefinition RetrieveMetadata response
    path
    representation
    sliceName
    sliceIsConstraining
    label
    code
    slicing
        discriminator
            type
            path
        description
        ordered
        rules
    short
    definition
    comment
    requirements
    alias
    min
    max
    base
        path
        min
        max
    contentReference
    type valueDomain.dataType
        code
        profile
        targetProfile
        aggregation
        versioning
    defaultValue[x]
    meaningWhenMissing
    orderMeaning
    fixed[x]
    pattern[x]
    example
        label
        value[x]
    minValue[x]
    maxValue[x]
    maxLength
    condition
    constraint
        key
        requirements
        severity
        suppress
        human
        expression
        xpath
        source
    mustSupport
    isModifier
    isModifierReason
    isSummary
    binding
        strength
        description
        valueSet valueDomain.valueSet
    mapping mappingSpecification
        identity
        language
        map
        comment
ElementDefinition Data_Element
    path Name, Identifier & Context
    representation n/a
    sliceName n/a
    sliceIsConstraining n/a
    label n/a
    code (Data_Element).data_element_concept.identifier
    slicing n/a
        discriminator n/a
            type
            path n/a
        description
        ordered n/a
        rules n/a
    short N/A
    definition (Designatable_Item).definition.text acceptability=preferred in default context
    comment (Administered_Item).explanatory_comment
    requirements (Registered_item).document_reference[document_type=requirements].notation
    alias (Designatable_Item).designation.sign acceptability!=preferred or context is other than default
    min Minimum size of data element values?
    max Maximum size of data element values?
    base n/a
        path n/a
        min n/a
        max n/a
    contentReference
    type .domain.data+Q14type
        code .domain.data+Q14type
        profile n/a
        targetProfile n/a
        aggregation n/a
        versioning
    defaultValue[x]
    meaningWhenMissing
    orderMeaning
    fixed[x] N/A (only relevant when constraining, which 11179 doesn't do)
    pattern[x]
    example
        label
        value[x] .example
    minValue[x]
    maxValue[x]
    maxLength .domain.maximum_character_quantity
    condition
    constraint ??
        key
        requirements
        severity
        suppress
        human
        expression
        xpath
        source
    mustSupport ??
    isModifier ??
    isModifierReason
    isSummary ??
    binding .domain
        strength
        description .domain.description
        valueSet points to explicit list or expression that evaluates to list of (Enumerated_Value_Domain).member
    mapping Registered_item).document_reference[document_type=mapping] Also, .meaning linkage to Data_Element_Concept is done as a normative part mapping to a reference model. (Data_Element_Concepts are all defined in some sort of reference model, be that Object_Class and Property or some other mechanism)
        identity
        language
        map ObjectClass, Property (this is one possible data model that can be mapped to - the specification. uri would identify the data model mappingSpecification.mappingScript
        comment