FHIR CI-Build
DiagnosticsThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
| Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
Raw Turtle (+ also see Turtle/RDF Format Specification)
StructureDefinition for documentreference
@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
# - resource -------------------------------------------------------------------
[] a fhir:StructureDefinition ;
fhir:id [ fhir:v "DocumentReference"] ;
fhir:meta [
fhir:lastUpdated [ fhir:v "2024-11-20T15:00:58.888+00:00" ]
] ;
fhir:text [
fhir:status [ fhir:v "generated" ]
] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "trial-use" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ] ;
fhir:value [ fhir:v "oo" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ] ;
fhir:value [ fhir:v "4" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category" ] ;
fhir:value [ fhir:v "not-classified" ]
] ) ;
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference"], [ fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference"] ;
fhir:version [ fhir:v "6.0.0-ballot2"], [ fhir:v "6.0.0-ballot2"] ;
fhir:name [ fhir:v "DocumentReference"], [ fhir:v "DocumentReference"] ;
fhir:status [ fhir:v "draft"], [ fhir:v "draft"] ;
fhir:experimental [ fhir:v "false"], [ fhir:v "false"] ;
fhir:date [ fhir:v "2024-11-20T15:00:58+00:00"], [ fhir:v "2024-11-20T15:00:58+00:00"] ;
fhir:publisher [ fhir:v "HL7 International / Orders and Observations"], [ fhir:v "HL7 International / Orders and Observations"] ;
fhir:contact ( [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/orders" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/orders" ]
] )
] ) ;
fhir:description [ fhir:v "A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this “document” encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference."], [ fhir:v "A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this “document” encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference."] ;
fhir:jurisdiction ( [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] ) ;
fhir:fhirVersion [ fhir:v "6.0.0-ballot2"] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:uri [ fhir:v "http://hl7.org/fhir/workflow" ] ;
fhir:name [ fhir:v "Workflow Pattern" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:uri [ fhir:v "http://hl7.org/fhir/fivews" ] ;
fhir:name [ fhir:v "FiveWs Pattern Mapping" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:uri [ fhir:v "http://hl7.org/fhir/composition" ] ;
fhir:name [ fhir:v "FHIR Composition" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:uri [ fhir:v "http://hl7.org/v3" ] ;
fhir:name [ fhir:v "RIM Mapping" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:uri [ fhir:v "http://ihe.net/xds" ] ;
fhir:name [ fhir:v "XDS metadata equivalent" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:uri [ fhir:v "http://hl7.org/v3/cda" ] ;
fhir:name [ fhir:v "CDA (R2)" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:uri [ fhir:v "http://hl7.org/v2" ] ;
fhir:name [ fhir:v "HL7 V2 Mapping" ]
] ) ;
fhir:kind [ fhir:v "resource"] ;
fhir:abstract [ fhir:v "false"] ;
fhir:type [ fhir:v "DocumentReference"] ;
fhir:baseDefinition [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource"] ;
fhir:derivation [ fhir:v "specialization"] ;
fhir:snapshot [
fhir:element ( [
fhir:id [ fhir:v "DocumentReference" ] ;
fhir:path [ fhir:v "DocumentReference" ] ;
fhir:short [ fhir:v "A reference to a document" ] ;
fhir:definition [ fhir:v "A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this \"document\" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference." ] ;
fhir:comment [ fhir:v "Usually, this is used for documents other than those defined by FHIR." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:constraint ( [
fhir:key [ fhir:v "docRef-1" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "facilityType SHALL only be present if context is not an encounter" ] ;
fhir:expression [ fhir:v "facilityType.empty() or context.where(resolve() is Encounter).empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
] [
fhir:key [ fhir:v "docRef-2" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "practiceSetting SHALL only be present if context is not present" ] ;
fhir:expression [ fhir:v "practiceSetting.empty() or context.where(resolve() is Encounter).empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
] [
fhir:key [ fhir:v "dom-2" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "If the resource is contained in another resource, it SHALL NOT contain nested Resources" ] ;
fhir:expression [ fhir:v "contained.contained.empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] [
fhir:key [ fhir:v "dom-3" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource" ] ;
fhir:expression [ fhir:v "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] [
fhir:key [ fhir:v "dom-4" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" ] ;
fhir:expression [ fhir:v "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] [
fhir:key [ fhir:v "dom-5" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "If a resource is contained in another resource, it SHALL NOT have a security label" ] ;
fhir:expression [ fhir:v "contained.meta.security.empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice" ] ;
fhir:value [ fhir:v "true" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation" ] ;
fhir:value [ fhir:v "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." ]
] ) ;
fhir:key [ fhir:v "dom-6" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "A resource should have narrative for robust management" ] ;
fhir:expression [ fhir:v "text.`div`.exists()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "Entity, Role, or Act,Document[classCode=\"DOC\" and moodCode=\"EVN\"]" ]
] [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "infrastructure.documents" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "when describing a Composition" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "when describing a CDA" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.id" ] ;
fhir:path [ fhir:v "DocumentReference.id" ] ;
fhir:short [ fhir:v "Logical id of this artifact" ] ;
fhir:definition [ fhir:v "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Resource.id" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ;
fhir:value [ fhir:v "id" ]
] ) ;
fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "DocumentReference.meta" ] ;
fhir:path [ fhir:v "DocumentReference.meta" ] ;
fhir:short [ fhir:v "Metadata about the resource" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Resource.meta" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Meta" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "DocumentReference.implicitRules" ] ;
fhir:path [ fhir:v "DocumentReference.implicitRules" ] ;
fhir:short [ fhir:v "A set of rules under which this content was created" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Resource.implicitRules" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "uri" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "DocumentReference.language" ] ;
fhir:path [ fhir:v "DocumentReference.language" ] ;
fhir:short [ fhir:v "Language of the resource content" ] ;
fhir:definition [ fhir:v "The base language in which the resource is written." ] ;
fhir:comment [ fhir:v "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)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Resource.language" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "Language" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "IETF language tag for a human language" ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2" ] ;
fhir:additional ( [
fhir:purpose [ fhir:v "starter" ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/languages" ]
] )
]
] [
fhir:id [ fhir:v "DocumentReference.text" ] ;
fhir:path [ fhir:v "DocumentReference.text" ] ;
fhir:short [ fhir:v "Text summary of the resource, for human interpretation" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "narrative" ] [ fhir:v "html" ] [ fhir:v "xhtml" ] [ fhir:v "display" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DomainResource.text" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Narrative" ]
] ) ;
fhir:condition ( [ fhir:v "dom-6" ] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "Act.text?" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.contained" ] ;
fhir:path [ fhir:v "DocumentReference.contained" ] ;
fhir:short [ fhir:v "Contained, inline Resources" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "inline resources" ] [ fhir:v "anonymous resources" ] [ fhir:v "contained resources" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DomainResource.contained" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Resource" ]
] ) ;
fhir:condition ( [ fhir:v "dom-2" ] [ fhir:v "dom-4" ] [ fhir:v "dom-3" ] [ fhir:v "dom-5" ] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.extension" ] ;
fhir:path [ fhir:v "DocumentReference.extension" ] ;
fhir:short [ fhir:v "Additional content defined by implementations" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DomainResource.extension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.modifierExtension" ] ;
fhir:path [ fhir:v "DocumentReference.modifierExtension" ] ;
fhir:short [ fhir:v "Extensions that cannot be ignored" ] ;
fhir:definition [ fhir:v "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "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](extensibility.html#modifierExtension)." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DomainResource.modifierExtension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.identifier" ] ;
fhir:path [ fhir:v "DocumentReference.identifier" ] ;
fhir:short [ fhir:v "Business identifiers for the document" ] ;
fhir:definition [ fhir:v "Business identifiers assigned to this document reference by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server." ] ;
fhir:comment [ fhir:v "The structure and format of this identifier would be consistent with the specification corresponding to the format of the document. (e.g. for a DICOM standard document, a 64-character numeric UID; for an HL7 CDA format, the CDA Document Id root and extension)." ] ;
fhir:requirements [ fhir:v "Document identifiers usually assigned by the source of the document, or other business identifiers such as XDS DocumentEntry.uniqueId and DocumentEntry.entryUUID. These identifiers are specific to this instance of the document." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.identifier" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Identifier" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.identifier" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.identifier" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.identifier" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-12" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".id / .setId" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.entryUUID, DocumentEntry.uniqueId" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/id" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.version" ] ;
fhir:path [ fhir:v "DocumentReference.version" ] ;
fhir:short [ fhir:v "An explicitly assigned identifier of a variation of the content in the DocumentReference" ] ;
fhir:definition [ fhir:v "An explicitly assigned identifier of a variation of the content in the DocumentReference." ] ;
fhir:comment [ fhir:v "While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.version" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.version" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.version" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.basedOn" ] ;
fhir:path [ fhir:v "DocumentReference.basedOn" ] ;
fhir:short [ fhir:v "Procedure that caused this media to be created" ] ;
fhir:definition [ fhir:v "A procedure that is fulfilled in whole or in part by the creation of this media." ] ;
fhir:requirements [ fhir:v "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon." ] ;
fhir:alias ( [ fhir:v "fulfills" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.basedOn" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Appointment" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/AppointmentResponse" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/CarePlan" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Claim" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/CommunicationRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Contract" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/DeviceRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/MedicationRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/NutritionOrder" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RequestOrchestration" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/SupplyRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/VisionPrescription" ] )
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.basedOn" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship[typeCode=FLFS].target" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.referenceIdList" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.status" ] ;
fhir:path [ fhir:v "DocumentReference.status" ] ;
fhir:short [ fhir:v "current | superseded | entered-in-error" ] ;
fhir:definition [ fhir:v "The current state of the document reference." ] ;
fhir:comment [ fhir:v "This is the status of the DocumentReference object, which might be independent from the docStatus element.\n\nThis element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.status" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentReferenceStatus" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "The status of the document reference." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/document-reference-status|6.0.0-ballot2" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.status" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.status" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-19" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\"; final: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\"" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.availabilityStatus" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.docStatus" ] ;
fhir:path [ fhir:v "DocumentReference.docStatus" ] ;
fhir:short [ fhir:v "registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown" ] ;
fhir:definition [ fhir:v "The status of the underlying document." ] ;
fhir:comment [ fhir:v "The document that is pointed to might be in various lifecycle states." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.docStatus" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ReferredDocumentStatus" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "Status of the underlying document." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/composition-status|6.0.0-ballot2" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.status" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.status" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-17" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".statusCode" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.modality" ] ;
fhir:path [ fhir:v "DocumentReference.modality" ] ;
fhir:short [ fhir:v "Imaging modality used" ] ;
fhir:definition [ fhir:v "Imaging modality used. This may include both acquisition and non-acquisition modalities." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.modality" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ImagingModality" ]
] ) ;
fhir:strength [ fhir:v "extensible" ] ;
fhir:description [ fhir:v "Type of acquired data in the instance." ] ;
fhir:valueSet [ fhir:v "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.class" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.type" ] ;
fhir:path [ fhir:v "DocumentReference.type" ] ;
fhir:short [ fhir:v "Kind of document (LOINC if possible)" ] ;
fhir:definition [ fhir:v "Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced." ] ;
fhir:comment [ fhir:v "Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.type" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentType" ]
] ) ;
fhir:strength [ fhir:v "preferred" ] ;
fhir:description [ fhir:v "Precise type of clinical document." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/doc-typecodes" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.code" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.what[x]" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.type" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-2" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.typeCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/code/@code \n\nThe typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted." ]
] )
] [
fhir:id [ fhir:v "DocumentReference.category" ] ;
fhir:path [ fhir:v "DocumentReference.category" ] ;
fhir:short [ fhir:v "Categorization of document" ] ;
fhir:definition [ fhir:v "A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type." ] ;
fhir:comment [ fhir:v "Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching." ] ;
fhir:alias ( [ fhir:v "class" ] [ fhir:v "classCode" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.category" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ReferencedItemCategory" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "High-level kind of document at a macro level." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/referenced-item-category" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.category" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.what[x]" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.category" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.classCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.subject" ] ;
fhir:path [ fhir:v "DocumentReference.subject" ] ;
fhir:short [ fhir:v "Who/what is the subject of the document" ] ;
fhir:definition [ fhir:v "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.subject" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Resource" ] )
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.subject" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.subject[x]" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.subject" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "PID-3 (No standard way to define a Practitioner or Group subject in HL7 V2 MDM message)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.patientId" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/recordTarget/" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.context" ] ;
fhir:path [ fhir:v "DocumentReference.context" ] ;
fhir:short [ fhir:v "Encounter the document reference is part of" ] ;
fhir:definition [ fhir:v "The Encounter during which this document reference was created or to which the creation of this record is tightly associated." ] ;
fhir:comment [ fhir:v "This will typically be the encounter the document reference was created during, but some document references may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests)." ] ;
fhir:requirements [ fhir:v "Links the document reference to the Encounter context. May also affect access control." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.context" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Appointment" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Encounter" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ] )
] ) ;
fhir:condition ( [ fhir:v "docRef-1" ] [ fhir:v "docRef-2" ] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.encounter" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.context" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.encounter" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.event" ] ;
fhir:path [ fhir:v "DocumentReference.event" ] ;
fhir:short [ fhir:v "Main clinical acts documented" ] ;
fhir:definition [ fhir:v "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act." ] ;
fhir:comment [ fhir:v "An event can further specialize the act inherent in the type, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.event" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableReference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Resource" ] )
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentEventType" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "This list of codes represents the main clinical acts being documented." ] ;
fhir:valueSet [ fhir:v "http://terminology.hl7.org/ValueSet/v3-ActCode" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.event.detail" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.eventCodeList" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.related" ] ;
fhir:path [ fhir:v "DocumentReference.related" ] ;
fhir:short [ fhir:v "Related identifiers or resources associated with the document reference" ] ;
fhir:definition [ fhir:v "Any other resource this document reference was created or to which the creation of this record is tightly associated." ] ;
fhir:comment [ fhir:v "Use only for references not covered by other elements." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.related" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Resource" ] )
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.event.detail" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct]" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.referenceIdList" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.bodySite" ] ;
fhir:path [ fhir:v "DocumentReference.bodySite" ] ;
fhir:short [ fhir:v "Body part included" ] ;
fhir:definition [ fhir:v "The anatomic structures included in the document." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.bodySite" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableReference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/BodyStructure" ] )
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "Codes describing anatomical locations. May include laterality." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "BodySite" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "SNOMED CT Body site concepts" ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/body-site" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".targetSiteCode" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.facilityType" ] ;
fhir:path [ fhir:v "DocumentReference.facilityType" ] ;
fhir:short [ fhir:v "Kind of facility where patient was seen" ] ;
fhir:definition [ fhir:v "The kind of facility where the patient was seen." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.facilityType" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:condition ( [ fhir:v "docRef-1" ] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentC80FacilityType" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "XDS Facility Type." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/c80-facilitycodes" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "usually from a mapping to a local ValueSet" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.healthcareFacilityTypeCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.practiceSetting" ] ;
fhir:path [ fhir:v "DocumentReference.practiceSetting" ] ;
fhir:short [ fhir:v "Additional details about where the content was created (e.g. clinical specialty)" ] ;
fhir:definition [ fhir:v "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty." ] ;
fhir:comment [ fhir:v "This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC." ] ;
fhir:requirements [ fhir:v "This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.practiceSetting" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:condition ( [ fhir:v "docRef-2" ] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentC80PracticeSetting" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "Additional details about where the content was created (e.g. clinical specialty)." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/c80-practice-codes" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "usually from a mapping to a local ValueSet" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.practiceSettingCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "usually from a mapping to a local ValueSet" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.period" ] ;
fhir:path [ fhir:v "DocumentReference.period" ] ;
fhir:short [ fhir:v "Time of service that is being documented" ] ;
fhir:definition [ fhir:v "The time period over which the service that is described by the document was provided." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.period" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Period" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.occurrence[x]" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.done[x]" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.event.period" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".effectiveTime" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/low/\n@value --> ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/high/\n@value" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.date" ] ;
fhir:path [ fhir:v "DocumentReference.date" ] ;
fhir:short [ fhir:v "When this document reference was created" ] ;
fhir:definition [ fhir:v "When the document reference was created." ] ;
fhir:comment [ fhir:v "Referencing/indexing time is used for tracking, organizing versions and searching. Provide the most precise timestamp available." ] ;
fhir:alias ( [ fhir:v "indexed" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.date" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "dateTime" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.recorded" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.recorded" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.date" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".availabilityTime[type=\"TS\"]" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.author" ] ;
fhir:path [ fhir:v "DocumentReference.author" ] ;
fhir:short [ fhir:v "Who and/or what authored the document" ] ;
fhir:definition [ fhir:v "Identifies who is responsible for adding the information to the document." ] ;
fhir:comment [ fhir:v "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.author" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Practitioner" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Device" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/CareTeam" ] )
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.performer.actor" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.author" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.author" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-9 (No standard way to indicate a Device in HL7 V2 MDM message)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.author" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/author" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester" ] ;
fhir:path [ fhir:v "DocumentReference.attester" ] ;
fhir:short [ fhir:v "Attests to accuracy of the document" ] ;
fhir:definition [ fhir:v "A participant who has authenticated the accuracy of the document." ] ;
fhir:comment [ fhir:v "Only list each attester once." ] ;
fhir:requirements [ fhir:v "Identifies responsibility for the accuracy of the document content." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.attester" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "BackboneElement" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.attester" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.legalAuthenticator" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v ".authenticator/.legalAuthenticator" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester.id" ] ;
fhir:path [ fhir:v "DocumentReference.attester.id" ] ;
fhir:representation ( [ fhir:v "xmlAttr" ] ) ;
fhir:short [ fhir:v "Unique id for inter-element referencing" ] ;
fhir:definition [ fhir:v "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Element.id" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ;
fhir:value [ fhir:v "string" ]
] ) ;
fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ]
] ) ;
fhir:condition ( [ fhir:v "ele-1" ] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester.extension" ] ;
fhir:path [ fhir:v "DocumentReference.attester.extension" ] ;
fhir:short [ fhir:v "Additional content defined by implementations" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "Element.extension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester.modifierExtension" ] ;
fhir:path [ fhir:v "DocumentReference.attester.modifierExtension" ] ;
fhir:short [ fhir:v "Extensions that cannot be ignored even if unrecognized" ] ;
fhir:definition [ fhir:v "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "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](extensibility.html#modifierExtension)." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] [ fhir:v "modifiers" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "BackboneElement.modifierExtension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester.mode" ] ;
fhir:path [ fhir:v "DocumentReference.attester.mode" ] ;
fhir:short [ fhir:v "personal | professional | legal | official" ] ;
fhir:definition [ fhir:v "The type of attestation the authenticator offers." ] ;
fhir:requirements [ fhir:v "Indicates the level of authority of the attestation." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.attester.mode" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentAttestationMode" ]
] ) ;
fhir:strength [ fhir:v "preferred" ] ;
fhir:description [ fhir:v "The way in which a person authenticated a document." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/composition-attestation-mode" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.attester.mode" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(./modeCode)" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "implied by .authenticator/.legalAuthenticator" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester.time" ] ;
fhir:path [ fhir:v "DocumentReference.attester.time" ] ;
fhir:short [ fhir:v "When the document was attested" ] ;
fhir:definition [ fhir:v "When the document was attested by the party." ] ;
fhir:requirements [ fhir:v "Identifies when the information in the document was deemed accurate. (Things may have changed since then.)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.attester.time" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "dateTime" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.attester.time" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./time[type=\"TS\" and isNormalDatatype()]" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v ".authenticator.time" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester.party" ] ;
fhir:path [ fhir:v "DocumentReference.attester.party" ] ;
fhir:short [ fhir:v "Who attested the document" ] ;
fhir:definition [ fhir:v "Who attested the document in the specified way." ] ;
fhir:requirements [ fhir:v "Identifies who has taken on the responsibility for accuracy of the document content." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.attester.party" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Practitioner" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] )
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.witness" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.attester.party" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-10" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./role[classCode=\"ASSIGNED\" and isNormalRole]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"PSN\") and isNormalEntity()] or ./role[classCode=\"ASSIGNED\" and isNormalRole and not(player)]/scoper[determinerCode=\"INST\" and classCode=\"ORG\" and isNormalEntity()]" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v ".authenticator.assignedEnttty" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.custodian" ] ;
fhir:path [ fhir:v "DocumentReference.custodian" ] ;
fhir:short [ fhir:v "Organization which maintains the document" ] ;
fhir:definition [ fhir:v "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document." ] ;
fhir:comment [ fhir:v "Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.custodian" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] )
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.custodian" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.relatesTo" ] ;
fhir:path [ fhir:v "DocumentReference.relatesTo" ] ;
fhir:short [ fhir:v "Relationships to other documents" ] ;
fhir:definition [ fhir:v "Relationships that this document has with other document references that already exist." ] ;
fhir:comment [ fhir:v "This element is labeled as a modifier because documents that append to other documents are incomplete on their own." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.relatesTo" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "BackboneElement" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.relatesTo" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry Associations" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.relatesTo.id" ] ;
fhir:path [ fhir:v "DocumentReference.relatesTo.id" ] ;
fhir:representation ( [ fhir:v "xmlAttr" ] ) ;
fhir:short [ fhir:v "Unique id for inter-element referencing" ] ;
fhir:definition [ fhir:v "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Element.id" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ;
fhir:value [ fhir:v "string" ]
] ) ;
fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ]
] ) ;
fhir:condition ( [ fhir:v "ele-1" ] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.relatesTo.extension" ] ;
fhir:path [ fhir:v "DocumentReference.relatesTo.extension" ] ;
fhir:short [ fhir:v "Additional content defined by implementations" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "Element.extension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.relatesTo.modifierExtension" ] ;
fhir:path [ fhir:v "DocumentReference.relatesTo.modifierExtension" ] ;
fhir:short [ fhir:v "Extensions that cannot be ignored even if unrecognized" ] ;
fhir:definition [ fhir:v "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "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](extensibility.html#modifierExtension)." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] [ fhir:v "modifiers" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "BackboneElement.modifierExtension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.relatesTo.code" ] ;
fhir:path [ fhir:v "DocumentReference.relatesTo.code" ] ;
fhir:short [ fhir:v "The relationship type with another document" ] ;
fhir:definition [ fhir:v "The type of relationship that this document has with anther document." ] ;
fhir:comment [ fhir:v "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.relatesTo.code" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentRelationshipType" ]
] ) ;
fhir:strength [ fhir:v "extensible" ] ;
fhir:description [ fhir:v "The type of relationship between the documents." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/document-relationship-type" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.relatesTo.type" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship.typeCode" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry Associations type" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/relatedDocument/typeCode" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.relatesTo.target" ] ;
fhir:path [ fhir:v "DocumentReference.relatesTo.target" ] ;
fhir:short [ fhir:v "Target of the relationship" ] ;
fhir:definition [ fhir:v "The target document of this relationship." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.relatesTo.target" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference" ] )
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.relatesTo.resourceReference" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".target[classCode=\"DOC\", moodCode=\"EVN\"].id" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry Associations reference" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/relatedDocument/parentDocument" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.description" ] ;
fhir:path [ fhir:v "DocumentReference.description" ] ;
fhir:short [ fhir:v "Human-readable description" ] ;
fhir:definition [ fhir:v "Human-readable description of the source document." ] ;
fhir:comment [ fhir:v "What the document is about, a terse summary of the document." ] ;
fhir:requirements [ fhir:v "Helps humans to assess whether the document is of interest." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.description" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "markdown" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-25" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship[typeCode=\"SUBJ\"].target.text" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.comments" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.securityLabel" ] ;
fhir:path [ fhir:v "DocumentReference.securityLabel" ] ;
fhir:short [ fhir:v "Document security-tags" ] ;
fhir:definition [ fhir:v "A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened." ] ;
fhir:comment [ fhir:v "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n\nIn the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects." ] ;
fhir:requirements [ fhir:v "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.securityLabel" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "SecurityLabels" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "Example Security Labels from the Healthcare Privacy and Security Classification System." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/security-label-examples" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Bundle.meta.security" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-18" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".confidentialityCode" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.confidentialityCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/confidentialityCode/@code" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content" ] ;
fhir:path [ fhir:v "DocumentReference.content" ] ;
fhir:short [ fhir:v "Document referenced" ] ;
fhir:definition [ fhir:v "The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata." ] ;
fhir:comment [ fhir:v "content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo." ] ;
fhir:requirements [ fhir:v "Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.content" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "BackboneElement" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Bundle(Composition+*)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "document.text" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.id" ] ;
fhir:path [ fhir:v "DocumentReference.content.id" ] ;
fhir:representation ( [ fhir:v "xmlAttr" ] ) ;
fhir:short [ fhir:v "Unique id for inter-element referencing" ] ;
fhir:definition [ fhir:v "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Element.id" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ;
fhir:value [ fhir:v "string" ]
] ) ;
fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ]
] ) ;
fhir:condition ( [ fhir:v "ele-1" ] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.extension" ] ;
fhir:path [ fhir:v "DocumentReference.content.extension" ] ;
fhir:short [ fhir:v "Additional content defined by implementations" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "Element.extension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.modifierExtension" ] ;
fhir:path [ fhir:v "DocumentReference.content.modifierExtension" ] ;
fhir:short [ fhir:v "Extensions that cannot be ignored even if unrecognized" ] ;
fhir:definition [ fhir:v "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "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](extensibility.html#modifierExtension)." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] [ fhir:v "modifiers" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "BackboneElement.modifierExtension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.attachment" ] ;
fhir:path [ fhir:v "DocumentReference.content.attachment" ] ;
fhir:short [ fhir:v "Where to access the document" ] ;
fhir:definition [ fhir:v "The document or URL of the document along with critical metadata to prove content has integrity." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.content.attachment" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Attachment" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.language, \nComposition.title, \nComposition.date" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-3 for mime type" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "document.text" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.repositoryUniqueId, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.profile" ] ;
fhir:path [ fhir:v "DocumentReference.content.profile" ] ;
fhir:short [ fhir:v "Content profile rules for the document" ] ;
fhir:definition [ fhir:v "An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType." ] ;
fhir:comment [ fhir:v "Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.\n\nFor FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with." ] ;
fhir:alias ( [ fhir:v "format" ] [ fhir:v "formatCode" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.content.profile" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "BackboneElement" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.meta.profile" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "document.text" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.formatCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "derived from the IHE Profile or Implementation Guide templateID" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.profile.id" ] ;
fhir:path [ fhir:v "DocumentReference.content.profile.id" ] ;
fhir:representation ( [ fhir:v "xmlAttr" ] ) ;
fhir:short [ fhir:v "Unique id for inter-element referencing" ] ;
fhir:definition [ fhir:v "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Element.id" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ;
fhir:value [ fhir:v "string" ]
] ) ;
fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ]
] ) ;
fhir:condition ( [ fhir:v "ele-1" ] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.profile.extension" ] ;
fhir:path [ fhir:v "DocumentReference.content.profile.extension" ] ;
fhir:short [ fhir:v "Additional content defined by implementations" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "Element.extension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.profile.modifierExtension" ] ;
fhir:path [ fhir:v "DocumentReference.content.profile.modifierExtension" ] ;
fhir:short [ fhir:v "Extensions that cannot be ignored even if unrecognized" ] ;
fhir:definition [ fhir:v "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "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](extensibility.html#modifierExtension)." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] [ fhir:v "modifiers" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "BackboneElement.modifierExtension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.profile.value[x]" ] ;
fhir:path [ fhir:v "DocumentReference.content.profile.value[x]" ] ;
fhir:short [ fhir:v "Code|uri|canonical" ] ;
fhir:definition [ fhir:v "Code|uri|canonical." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DocumentReference.content.profile.value[x]" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Coding" ]
] [
fhir:code [ fhir:v "uri" ]
] [
fhir:code [ fhir:v "canonical" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentFormat" ]
] ) ;
fhir:strength [ fhir:v "preferred" ] ;
fhir:description [ fhir:v "Document Format Codes." ] ;
fhir:valueSet [ fhir:v "http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.meta.profile" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "document.text" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.formatCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "derived from the IHE Profile or Implementation Guide templateID" ]
] )
] )
] ;
fhir:differential [
fhir:element ( [
fhir:id [ fhir:v "DocumentReference" ] ;
fhir:path [ fhir:v "DocumentReference" ] ;
fhir:short [ fhir:v "A reference to a document" ] ;
fhir:definition [ fhir:v "A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this \"document\" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference." ] ;
fhir:comment [ fhir:v "Usually, this is used for documents other than those defined by FHIR." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:constraint ( [
fhir:key [ fhir:v "docRef-1" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "facilityType SHALL only be present if context is not an encounter" ] ;
fhir:expression [ fhir:v "facilityType.empty() or context.where(resolve() is Encounter).empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
] [
fhir:key [ fhir:v "docRef-2" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "practiceSetting SHALL only be present if context is not present" ] ;
fhir:expression [ fhir:v "practiceSetting.empty() or context.where(resolve() is Encounter).empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "infrastructure.documents" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "when describing a Composition" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "Document[classCode=\"DOC\" and moodCode=\"EVN\"]" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "when describing a CDA" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.identifier" ] ;
fhir:path [ fhir:v "DocumentReference.identifier" ] ;
fhir:short [ fhir:v "Business identifiers for the document" ] ;
fhir:definition [ fhir:v "Business identifiers assigned to this document reference by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server." ] ;
fhir:comment [ fhir:v "The structure and format of this identifier would be consistent with the specification corresponding to the format of the document. (e.g. for a DICOM standard document, a 64-character numeric UID; for an HL7 CDA format, the CDA Document Id root and extension)." ] ;
fhir:requirements [ fhir:v "Document identifiers usually assigned by the source of the document, or other business identifiers such as XDS DocumentEntry.uniqueId and DocumentEntry.entryUUID. These identifiers are specific to this instance of the document." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "Identifier" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.identifier" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.identifier" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.identifier" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-12" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".id / .setId" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.entryUUID, DocumentEntry.uniqueId" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/id" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.version" ] ;
fhir:path [ fhir:v "DocumentReference.version" ] ;
fhir:short [ fhir:v "An explicitly assigned identifier of a variation of the content in the DocumentReference" ] ;
fhir:definition [ fhir:v "An explicitly assigned identifier of a variation of the content in the DocumentReference." ] ;
fhir:comment [ fhir:v "While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.version" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.version" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.basedOn" ] ;
fhir:path [ fhir:v "DocumentReference.basedOn" ] ;
fhir:short [ fhir:v "Procedure that caused this media to be created" ] ;
fhir:definition [ fhir:v "A procedure that is fulfilled in whole or in part by the creation of this media." ] ;
fhir:requirements [ fhir:v "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon." ] ;
fhir:alias ( [ fhir:v "fulfills" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Appointment" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/AppointmentResponse" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/CarePlan" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Claim" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/CommunicationRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Contract" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/DeviceRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/MedicationRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/NutritionOrder" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RequestOrchestration" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/SupplyRequest" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/VisionPrescription" ] )
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.basedOn" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship[typeCode=FLFS].target" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.referenceIdList" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.status" ] ;
fhir:path [ fhir:v "DocumentReference.status" ] ;
fhir:short [ fhir:v "current | superseded | entered-in-error" ] ;
fhir:definition [ fhir:v "The current state of the document reference." ] ;
fhir:comment [ fhir:v "This is the status of the DocumentReference object, which might be independent from the docStatus element.\n\nThis element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentReferenceStatus" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "The status of the document reference." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/document-reference-status|6.0.0-ballot2" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.status" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.status" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-19" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\"; final: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\"" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.availabilityStatus" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.docStatus" ] ;
fhir:path [ fhir:v "DocumentReference.docStatus" ] ;
fhir:short [ fhir:v "registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown" ] ;
fhir:definition [ fhir:v "The status of the underlying document." ] ;
fhir:comment [ fhir:v "The document that is pointed to might be in various lifecycle states." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ReferredDocumentStatus" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "Status of the underlying document." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/composition-status|6.0.0-ballot2" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.status" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.status" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-17" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".statusCode" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.modality" ] ;
fhir:path [ fhir:v "DocumentReference.modality" ] ;
fhir:short [ fhir:v "Imaging modality used" ] ;
fhir:definition [ fhir:v "Imaging modality used. This may include both acquisition and non-acquisition modalities." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ImagingModality" ]
] ) ;
fhir:strength [ fhir:v "extensible" ] ;
fhir:description [ fhir:v "Type of acquired data in the instance." ] ;
fhir:valueSet [ fhir:v "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.class" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.type" ] ;
fhir:path [ fhir:v "DocumentReference.type" ] ;
fhir:short [ fhir:v "Kind of document (LOINC if possible)" ] ;
fhir:definition [ fhir:v "Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced." ] ;
fhir:comment [ fhir:v "Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentType" ]
] ) ;
fhir:strength [ fhir:v "preferred" ] ;
fhir:description [ fhir:v "Precise type of clinical document." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/doc-typecodes" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.code" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.what[x]" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.type" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-2" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.typeCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/code/@code \n\nThe typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted." ]
] )
] [
fhir:id [ fhir:v "DocumentReference.category" ] ;
fhir:path [ fhir:v "DocumentReference.category" ] ;
fhir:short [ fhir:v "Categorization of document" ] ;
fhir:definition [ fhir:v "A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type." ] ;
fhir:comment [ fhir:v "Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching." ] ;
fhir:alias ( [ fhir:v "class" ] [ fhir:v "classCode" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "ReferencedItemCategory" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "High-level kind of document at a macro level." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/referenced-item-category" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.category" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.what[x]" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.category" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.classCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.subject" ] ;
fhir:path [ fhir:v "DocumentReference.subject" ] ;
fhir:short [ fhir:v "Who/what is the subject of the document" ] ;
fhir:definition [ fhir:v "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Resource" ] )
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.subject" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.subject[x]" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.subject" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "PID-3 (No standard way to define a Practitioner or Group subject in HL7 V2 MDM message)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.patientId" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/recordTarget/" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.context" ] ;
fhir:path [ fhir:v "DocumentReference.context" ] ;
fhir:short [ fhir:v "Encounter the document reference is part of" ] ;
fhir:definition [ fhir:v "The Encounter during which this document reference was created or to which the creation of this record is tightly associated." ] ;
fhir:comment [ fhir:v "This will typically be the encounter the document reference was created during, but some document references may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests)." ] ;
fhir:requirements [ fhir:v "Links the document reference to the Encounter context. May also affect access control." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Appointment" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Encounter" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ] )
] ) ;
fhir:condition ( [ fhir:v "docRef-1" ] [ fhir:v "docRef-2" ] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.encounter" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.context" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.encounter" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.event" ] ;
fhir:path [ fhir:v "DocumentReference.event" ] ;
fhir:short [ fhir:v "Main clinical acts documented" ] ;
fhir:definition [ fhir:v "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act." ] ;
fhir:comment [ fhir:v "An event can further specialize the act inherent in the type, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableReference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Resource" ] )
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentEventType" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "This list of codes represents the main clinical acts being documented." ] ;
fhir:valueSet [ fhir:v "http://terminology.hl7.org/ValueSet/v3-ActCode" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.event.detail" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.eventCodeList" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.related" ] ;
fhir:path [ fhir:v "DocumentReference.related" ] ;
fhir:short [ fhir:v "Related identifiers or resources associated with the document reference" ] ;
fhir:definition [ fhir:v "Any other resource this document reference was created or to which the creation of this record is tightly associated." ] ;
fhir:comment [ fhir:v "Use only for references not covered by other elements." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Resource" ] )
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.event.detail" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct]" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.referenceIdList" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.bodySite" ] ;
fhir:path [ fhir:v "DocumentReference.bodySite" ] ;
fhir:short [ fhir:v "Body part included" ] ;
fhir:definition [ fhir:v "The anatomic structures included in the document." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableReference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/BodyStructure" ] )
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "Codes describing anatomical locations. May include laterality." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "BodySite" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "SNOMED CT Body site concepts" ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/body-site" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".targetSiteCode" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.facilityType" ] ;
fhir:path [ fhir:v "DocumentReference.facilityType" ] ;
fhir:short [ fhir:v "Kind of facility where patient was seen" ] ;
fhir:definition [ fhir:v "The kind of facility where the patient was seen." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:condition ( [ fhir:v "docRef-1" ] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentC80FacilityType" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "XDS Facility Type." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/c80-facilitycodes" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "usually from a mapping to a local ValueSet" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.healthcareFacilityTypeCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.practiceSetting" ] ;
fhir:path [ fhir:v "DocumentReference.practiceSetting" ] ;
fhir:short [ fhir:v "Additional details about where the content was created (e.g. clinical specialty)" ] ;
fhir:definition [ fhir:v "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty." ] ;
fhir:comment [ fhir:v "This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC." ] ;
fhir:requirements [ fhir:v "This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:condition ( [ fhir:v "docRef-2" ] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentC80PracticeSetting" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "Additional details about where the content was created (e.g. clinical specialty)." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/c80-practice-codes" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "usually from a mapping to a local ValueSet" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.practiceSettingCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "usually from a mapping to a local ValueSet" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.period" ] ;
fhir:path [ fhir:v "DocumentReference.period" ] ;
fhir:short [ fhir:v "Time of service that is being documented" ] ;
fhir:definition [ fhir:v "The time period over which the service that is described by the document was provided." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "Period" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.occurrence[x]" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.done[x]" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.event.period" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".effectiveTime" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/low/\n@value --> ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/high/\n@value" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.date" ] ;
fhir:path [ fhir:v "DocumentReference.date" ] ;
fhir:short [ fhir:v "When this document reference was created" ] ;
fhir:definition [ fhir:v "When the document reference was created." ] ;
fhir:comment [ fhir:v "Referencing/indexing time is used for tracking, organizing versions and searching. Provide the most precise timestamp available." ] ;
fhir:alias ( [ fhir:v "indexed" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "dateTime" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.recorded" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.recorded" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.date" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".availabilityTime[type=\"TS\"]" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.author" ] ;
fhir:path [ fhir:v "DocumentReference.author" ] ;
fhir:short [ fhir:v "Who and/or what authored the document" ] ;
fhir:definition [ fhir:v "Identifies who is responsible for adding the information to the document." ] ;
fhir:comment [ fhir:v "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Practitioner" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Device" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/CareTeam" ] )
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "workflow" ] ;
fhir:map [ fhir:v "Event.performer.actor" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.author" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.author" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-9 (No standard way to indicate a Device in HL7 V2 MDM message)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.author" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/author" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester" ] ;
fhir:path [ fhir:v "DocumentReference.attester" ] ;
fhir:short [ fhir:v "Attests to accuracy of the document" ] ;
fhir:definition [ fhir:v "A participant who has authenticated the accuracy of the document." ] ;
fhir:comment [ fhir:v "Only list each attester once." ] ;
fhir:requirements [ fhir:v "Identifies responsibility for the accuracy of the document content." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "BackboneElement" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.attester" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.legalAuthenticator" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v ".authenticator/.legalAuthenticator" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester.mode" ] ;
fhir:path [ fhir:v "DocumentReference.attester.mode" ] ;
fhir:short [ fhir:v "personal | professional | legal | official" ] ;
fhir:definition [ fhir:v "The type of attestation the authenticator offers." ] ;
fhir:requirements [ fhir:v "Indicates the level of authority of the attestation." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentAttestationMode" ]
] ) ;
fhir:strength [ fhir:v "preferred" ] ;
fhir:description [ fhir:v "The way in which a person authenticated a document." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/composition-attestation-mode" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.attester.mode" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(./modeCode)" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "implied by .authenticator/.legalAuthenticator" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester.time" ] ;
fhir:path [ fhir:v "DocumentReference.attester.time" ] ;
fhir:short [ fhir:v "When the document was attested" ] ;
fhir:definition [ fhir:v "When the document was attested by the party." ] ;
fhir:requirements [ fhir:v "Identifies when the information in the document was deemed accurate. (Things may have changed since then.)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "dateTime" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.attester.time" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./time[type=\"TS\" and isNormalDatatype()]" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v ".authenticator.time" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.attester.party" ] ;
fhir:path [ fhir:v "DocumentReference.attester.party" ] ;
fhir:short [ fhir:v "Who attested the document" ] ;
fhir:definition [ fhir:v "Who attested the document in the specified way." ] ;
fhir:requirements [ fhir:v "Identifies who has taken on the responsibility for accuracy of the document content." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Practitioner" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] )
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.witness" ]
] [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.attester.party" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-10" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./role[classCode=\"ASSIGNED\" and isNormalRole]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"PSN\") and isNormalEntity()] or ./role[classCode=\"ASSIGNED\" and isNormalRole and not(player)]/scoper[determinerCode=\"INST\" and classCode=\"ORG\" and isNormalEntity()]" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v ".authenticator.assignedEnttty" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.custodian" ] ;
fhir:path [ fhir:v "DocumentReference.custodian" ] ;
fhir:short [ fhir:v "Organization which maintains the document" ] ;
fhir:definition [ fhir:v "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document." ] ;
fhir:comment [ fhir:v "Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] )
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.custodian" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.relatesTo" ] ;
fhir:path [ fhir:v "DocumentReference.relatesTo" ] ;
fhir:short [ fhir:v "Relationships to other documents" ] ;
fhir:definition [ fhir:v "Relationships that this document has with other document references that already exist." ] ;
fhir:comment [ fhir:v "This element is labeled as a modifier because documents that append to other documents are incomplete on their own." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "BackboneElement" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.relatesTo" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry Associations" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.relatesTo.code" ] ;
fhir:path [ fhir:v "DocumentReference.relatesTo.code" ] ;
fhir:short [ fhir:v "The relationship type with another document" ] ;
fhir:definition [ fhir:v "The type of relationship that this document has with anther document." ] ;
fhir:comment [ fhir:v "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentRelationshipType" ]
] ) ;
fhir:strength [ fhir:v "extensible" ] ;
fhir:description [ fhir:v "The type of relationship between the documents." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/document-relationship-type" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.relatesTo.type" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship.typeCode" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry Associations type" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/relatedDocument/typeCode" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.relatesTo.target" ] ;
fhir:path [ fhir:v "DocumentReference.relatesTo.target" ] ;
fhir:short [ fhir:v "Target of the relationship" ] ;
fhir:definition [ fhir:v "The target document of this relationship." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "Reference" ] ;
fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference" ] )
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.relatesTo.resourceReference" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".target[classCode=\"DOC\", moodCode=\"EVN\"].id" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry Associations reference" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/relatedDocument/parentDocument" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.description" ] ;
fhir:path [ fhir:v "DocumentReference.description" ] ;
fhir:short [ fhir:v "Human-readable description" ] ;
fhir:definition [ fhir:v "Human-readable description of the source document." ] ;
fhir:comment [ fhir:v "What the document is about, a terse summary of the document." ] ;
fhir:requirements [ fhir:v "Helps humans to assess whether the document is of interest." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "markdown" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-25" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".outboundRelationship[typeCode=\"SUBJ\"].target.text" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.comments" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.securityLabel" ] ;
fhir:path [ fhir:v "DocumentReference.securityLabel" ] ;
fhir:short [ fhir:v "Document security-tags" ] ;
fhir:definition [ fhir:v "A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened." ] ;
fhir:comment [ fhir:v "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n\nIn the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects." ] ;
fhir:requirements [ fhir:v "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "SecurityLabels" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "example" ] ;
fhir:description [ fhir:v "Example Security Labels from the Healthcare Privacy and Security Classification System." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/security-label-examples" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Bundle.meta.security" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-18" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v ".confidentialityCode" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.confidentialityCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/confidentialityCode/@code" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content" ] ;
fhir:path [ fhir:v "DocumentReference.content" ] ;
fhir:short [ fhir:v "Document referenced" ] ;
fhir:definition [ fhir:v "The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata." ] ;
fhir:comment [ fhir:v "content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo." ] ;
fhir:requirements [ fhir:v "Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "BackboneElement" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Bundle(Composition+*)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "document.text" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.attachment" ] ;
fhir:path [ fhir:v "DocumentReference.content.attachment" ] ;
fhir:short [ fhir:v "Where to access the document" ] ;
fhir:definition [ fhir:v "The document or URL of the document along with critical metadata to prove content has integrity." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "Attachment" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.language, \nComposition.title, \nComposition.date" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "TXA-3 for mime type" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "document.text" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.repositoryUniqueId, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.profile" ] ;
fhir:path [ fhir:v "DocumentReference.content.profile" ] ;
fhir:short [ fhir:v "Content profile rules for the document" ] ;
fhir:definition [ fhir:v "An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType." ] ;
fhir:comment [ fhir:v "Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.\n\nFor FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with." ] ;
fhir:alias ( [ fhir:v "format" ] [ fhir:v "formatCode" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "BackboneElement" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.meta.profile" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "document.text" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.formatCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "derived from the IHE Profile or Implementation Guide templateID" ]
] )
] [
fhir:id [ fhir:v "DocumentReference.content.profile.value[x]" ] ;
fhir:path [ fhir:v "DocumentReference.content.profile.value[x]" ] ;
fhir:short [ fhir:v "Code|uri|canonical" ] ;
fhir:definition [ fhir:v "Code|uri|canonical." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "Coding" ]
] [
fhir:code [ fhir:v "uri" ]
] [
fhir:code [ fhir:v "canonical" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "DocumentFormat" ]
] ) ;
fhir:strength [ fhir:v "preferred" ] ;
fhir:description [ fhir:v "Document Format Codes." ] ;
fhir:valueSet [ fhir:v "http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "fhircomposition" ] ;
fhir:map [ fhir:v "Composition.meta.profile" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "document.text" ]
] [
fhir:identity [ fhir:v "xds" ] ;
fhir:map [ fhir:v "DocumentEntry.formatCode" ]
] [
fhir:identity [ fhir:v "cda" ] ;
fhir:map [ fhir:v "derived from the IHE Profile or Implementation Guide templateID" ]
] )
] )
] .
# -------------------------------------------------------------------------------------
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Wed, Nov 20, 2024 15:07+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change