{
"description": "Explanation of what this profile contains/is for",
"_filename": "StructureDefinition-catalog-uv-livd.json",
"package_name": "hl7.fhir.uv.livd",
"date": "2018-08-14",
"derivation": "constraint",
"publisher": "Health Level Seven, Inc. - Orders and Observations WG",
"fhirVersion": "3.5.0",
"name": "LIVD Catalog",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)",
"identity": "cda"
}, {
"uri": "http://hl7.org/fhir/documentreference",
"name": "FHIR DocumentReference",
"identity": "fhirdocumentreference"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern",
"identity": "w5"
} ],
"abstract": false,
"type": "Composition",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "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",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a guman 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."
} ],
"expression": "text.div.exists()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
} ],
"path": "Composition",
"min": 0,
"definition": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).",
"isModifier": false,
"short": "LIVD Catalog",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct()]",
"identity": "rim"
}, {
"map": "ClinicalDocument",
"identity": "cda"
}, {
"map": "when described by DocumentReference",
"identity": "fhirdocumentreference"
} ],
"mustSupport": false,
"max": "*",
"id": "Composition",
"comment": "While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.",
"base": {
"max": "*",
"min": 0,
"path": "Composition"
},
"isSummary": false
}, {
"path": "Composition.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Composition.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Composition.meta",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Composition.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Composition.implicitRules",
"min": 0,
"definition": "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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Composition.implicitRules",
"comment": "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 it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"path": "Composition.language",
"min": 1,
"definition": "Provides the language that the LIVD Mapping Publication is expressed in.",
"isModifier": false,
"short": "Publication Language",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "Composition.language",
"comment": "This is represented using BCP-47 (http://tools.ietf.org/html/bcp47) which includes RFC-5646.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"path": "Composition.text",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Composition.text",
"comment": "Contained resources do not have 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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Composition.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Composition.contained",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"path": "Composition.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"path": "Composition.modifierExtension",
"min": 0,
"definition": "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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"path": "Composition.identifier",
"min": 1,
"definition": "The logical identifier for the publication by the vendor.",
"isModifier": false,
"short": "Logical identifier of the LIVD Publication",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "Document.id / Document.setId",
"identity": "rim"
}, {
"map": ".setId",
"identity": "cda"
}, {
"map": "DocumentReference.masterIdentifier",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.identifier",
"comment": "See discussion in resource definition for how these relate.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.identifier"
},
"isSummary": true
}, {
"path": "Composition.identifier.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.identifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.identifier.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.identifier.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary | old (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known ."
},
"max": "0",
"id": "Composition.identifier.use",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true
}, {
"path": "Composition.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"isModifier": false,
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
"max": "0",
"id": "Composition.identifier.type",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"path": "Composition.identifier.system",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"isModifier": false,
"short": "Publication Identifier Name Space",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.identifier.system",
"comment": "Identifier.system is always case sensitive.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"path": "Composition.identifier.value",
"min": 1,
"definition": "Provides the value of the identifier.",
"isModifier": false,
"short": "Publication Identifier Value",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.identifier.value",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"path": "Composition.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"isModifier": false,
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.identifier.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"path": "Composition.identifier.assigner",
"min": 1,
"definition": "Organization that issued/manages the identifier.",
"isModifier": false,
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.identifier.assigner",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"path": "Composition.identifier.assigner.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.identifier.assigner.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.identifier.assigner.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.identifier.assigner.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.identifier.assigner.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.identifier.assigner.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "Composition.identifier.assigner.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "Composition.identifier.assigner.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "Composition.identifier.assigner.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.identifier.assigner.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "Composition.identifier.assigner.display",
"min": 1,
"definition": "The display name of the organization that issued/manages the identifier.",
"isModifier": false,
"short": "Publication Vendor Name",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Composition.identifier.assigner.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "Composition.status",
"requirements": "Need to be able to mark interim, amended, or withdrawn compositions or documents.",
"min": 1,
"definition": "The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.",
"isModifier": true,
"short": "preliminary | final | amended | entered-in-error",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "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(\"ReviseComposition\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\"",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "DocumentReference.status",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/composition-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CompositionStatus"
} ],
"description": "The workflow/clinical status of the composition."
},
"max": "1",
"id": "Composition.status",
"comment": "Support for final is required, while other statuses are optional.\n\nPrior statuses listed (not accurate currently?:\ninterim | final | withdrawn.",
"base": {
"max": "1",
"min": 1,
"path": "Composition.status"
},
"isModifierReason": "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",
"isSummary": true
}, {
"path": "Composition.type",
"requirements": "Key metadata element describing the composition, used in searching/filtering.",
"min": 1,
"definition": "Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.",
"isModifier": false,
"short": "Kind of composition (LOINC if possible)",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": ".code",
"identity": "cda"
}, {
"map": "DocumentReference.type",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/doc-typecodes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentType"
} ],
"description": "Type of a composition."
},
"max": "1",
"id": "Composition.type",
"comment": "For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.",
"base": {
"max": "1",
"min": 1,
"path": "Composition.type"
},
"isSummary": true
}, {
"path": "Composition.type.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.type.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.type.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.type.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.type.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "Provides the LOINC Code for the LIVD Mapping Publication.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.type.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Composition.type.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.type.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.type.coding.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.type.coding.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.type.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "LOINC Coding System",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.type.coding.system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Composition.type.coding.version",
"min": 1,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"isModifier": false,
"short": "LOINC Code Version",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.type.coding.version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Composition.type.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "LOINC Code representing the LIVD Mapping Publication.",
"isModifier": false,
"short": "LIVD Mappipng Publication LOINC Code",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.type.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Composition.type.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"isModifier": false,
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Composition.type.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Composition.type.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.type.coding.userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Composition.type.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "Composition.type.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Composition.category",
"requirements": "Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.",
"min": 0,
"definition": "A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.",
"isModifier": false,
"short": "Categorization of Composition",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "DocumenttReference.category",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/document-classcodes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentCategory"
} ],
"description": "High-level kind of a clinical document at a macro level."
},
"max": "0",
"id": "Composition.category",
"comment": "This is a metadata field from [XDS/MHD](http://wiki.ihe.net/index.php?title=Mobile_access_to_Health_Documents_(MHD)).",
"base": {
"max": "*",
"min": 0,
"path": "Composition.category"
},
"isSummary": true
}, {
"path": "Composition.subject",
"requirements": "Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.",
"min": 0,
"definition": "Who or what the composition is about. The composition 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 livestock, or a set of patients that share a common exposure).",
"isModifier": false,
"short": "Who and/or what the composition is about",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]",
"identity": "rim"
}, {
"map": ".recordTarget",
"identity": "cda"
}, {
"map": "DocumentReference.subject",
"identity": "fhirdocumentreference"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.subject",
"comment": "For clinical documents, this is usually the patient.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.subject"
},
"isSummary": true
}, {
"path": "Composition.encounter",
"requirements": "Provides context for the composition and supports searching.",
"min": 0,
"definition": "Describes the clinical encounter or type of care this documentation is associated with.",
"isModifier": false,
"short": "Context of the Composition",
"mapping": [ {
"map": "Event.context",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])",
"identity": "rim"
}, {
"map": ".componentOf.encompassingEncounter",
"identity": "cda"
}, {
"map": "DocumentReference.context.encounter",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.encounter",
"base": {
"max": "1",
"min": 0,
"path": "Composition.encounter"
},
"isSummary": true
}, {
"path": "Composition.date",
"requirements": "dateTime is used for tracking, organizing versions and searching.",
"min": 1,
"definition": "The date the LIVD Mapping Publication was published.",
"isModifier": false,
"short": "Composition editing time",
"mapping": [ {
"map": "Event.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": ".effectiveTime[type=\"TS\"]",
"identity": "rim"
}, {
"map": ".effectiveTime",
"identity": "cda"
}, {
"map": "DocumentReference.content.attachment.date, DocumentReference.created",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.date",
"comment": "We do not need a separate effective date/time at this point.",
"base": {
"max": "1",
"min": 1,
"path": "Composition.date"
},
"isSummary": true
}, {
"path": "Composition.author",
"requirements": "Identifies who is responsible for the content.",
"min": 1,
"definition": "Identifies who is responsible for the information in the LIVD Mapping Publication, not necessarily who typed it in.",
"isModifier": false,
"short": "Who and/or what authored the composition",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": "FiveWs.author",
"identity": "w5"
}, {
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]",
"identity": "rim"
}, {
"map": ".author.assignedAuthor",
"identity": "cda"
}, {
"map": "DocumentReference.agent",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.author",
"base": {
"max": "*",
"min": 1,
"path": "Composition.author"
},
"isSummary": true
}, {
"path": "Composition.author.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.author.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.author.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.author.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.author.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.author.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "Composition.author.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "Composition.author.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "Composition.author.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.author.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "Composition.author.display",
"min": 1,
"definition": "The name of the vendor that authored the LIVD Mapping Publication.",
"isModifier": false,
"short": "Vendor Name",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Composition.author.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "Composition.title",
"min": 1,
"definition": "Official human-readable label for the LIVD Mapping Publication.",
"isModifier": false,
"short": "LIVD Mapping Publication Title",
"mapping": [ {
"map": "./title",
"identity": "rim"
}, {
"map": ".title",
"identity": "cda"
}, {
"map": "DocumentReference.description, DocumentReference.content.attachment.title",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.title",
"comment": "For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a \"consultation\" or \"progress note\"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.",
"base": {
"max": "1",
"min": 1,
"path": "Composition.title"
},
"isSummary": true
}, {
"path": "Composition.confidentiality",
"min": 0,
"definition": "The code specifying the level of confidentiality of the Composition.",
"isModifier": false,
"short": "As defined by affinity domain",
"mapping": [ {
"map": ".confidentialityCode",
"identity": "rim"
}, {
"map": ".confidentialityCode",
"identity": "cda"
}, {
"map": "DocumentReference.securityLabel",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentConfidentiality"
} ],
"description": "Codes specifying the level of confidentiality of the composition."
},
"max": "0",
"id": "Composition.confidentiality",
"comment": "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).\n\nThis element is labeled as a modifier because highly confidential documents must not be treated as if they are not.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.confidentiality"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Composition.attester",
"requirements": "Identifies responsibility for the accuracy of the composition content.",
"min": 0,
"definition": "A participant who has attested to the accuracy of the composition/document.",
"isModifier": false,
"short": "Attests to accuracy of composition",
"mapping": [ {
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]",
"identity": "rim"
}, {
"map": ".authenticator/.legalAuthenticator",
"identity": "cda"
}, {
"map": "DocumentReference.authenticator",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.attester",
"comment": "Only list each attester once.",
"base": {
"max": "*",
"min": 0,
"path": "Composition.attester"
},
"isSummary": false
}, {
"path": "Composition.attester.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.attester.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.attester.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.attester.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.attester.modifierExtension",
"min": 0,
"definition": "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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Composition.attester.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Composition.attester.mode",
"requirements": "Indicates the level of authority of the attestation.",
"min": 1,
"definition": "The type of attestation the authenticator offers.",
"isModifier": false,
"short": "personal | professional | legal | official",
"mapping": [ {
"map": "unique(./modeCode)",
"identity": "rim"
}, {
"map": "implied by .authenticator/.legalAuthenticator",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/composition-attestation-mode",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CompositionAttestationMode"
} ],
"description": "The way in which a person authenticated a composition."
},
"max": "1",
"id": "Composition.attester.mode",
"comment": "Use more than one code where a single attester has more than one mode (professional and legal are often paired).",
"base": {
"max": "1",
"min": 1,
"path": "Composition.attester.mode"
},
"isSummary": false
}, {
"path": "Composition.attester.time",
"requirements": "Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).",
"min": 0,
"definition": "When the composition was attested by the party.",
"isModifier": false,
"short": "When the composition was attested",
"mapping": [ {
"map": "./time[type=\"TS\" and isNormalDatatype()]",
"identity": "rim"
}, {
"map": ".authenticator.time",
"identity": "cda"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.attester.time",
"base": {
"max": "1",
"min": 0,
"path": "Composition.attester.time"
},
"isSummary": false
}, {
"path": "Composition.attester.party",
"requirements": "Identifies who has taken on the responsibility for accuracy of the composition content.",
"min": 0,
"definition": "Who attested the composition in the specified way.",
"isModifier": false,
"short": "Who attested the composition",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": "./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()]",
"identity": "rim"
}, {
"map": ".authenticator.assignedEnttty",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.attester.party",
"base": {
"max": "1",
"min": 0,
"path": "Composition.attester.party"
},
"isSummary": false
}, {
"path": "Composition.custodian",
"requirements": "Identifies where to go to find the current version, where to report issues, etc.",
"min": 0,
"definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.",
"isModifier": false,
"short": "Organization which maintains the composition",
"mapping": [ {
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]",
"identity": "rim"
}, {
"map": ".custodian.assignedCustodian",
"identity": "cda"
}, {
"map": "DocumentReference.custodian",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.custodian",
"comment": "This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.custodian"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Composition.relatesTo",
"min": 0,
"definition": "Relationships that this composition has with other compositions or documents that already exist.",
"isModifier": false,
"short": "Relationships to other compositions/documents",
"mapping": [ {
"map": ".outboundRelationship",
"identity": "rim"
}, {
"map": ".relatedDocument",
"identity": "cda"
}, {
"map": "DocumentReference.relatesTo",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.relatesTo",
"comment": "A document is a version specific composition.",
"base": {
"max": "*",
"min": 0,
"path": "Composition.relatesTo"
},
"isSummary": false
}, {
"path": "Composition.relatesTo.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.relatesTo.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.relatesTo.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.relatesTo.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.relatesTo.modifierExtension",
"min": 0,
"definition": "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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Composition.relatesTo.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Composition.relatesTo.code",
"min": 1,
"definition": "The type of relationship that this composition has with anther composition or document.",
"isModifier": false,
"short": "replaces | transforms | signs | appends",
"mapping": [ {
"map": ".outboundRelationship.typeCode",
"identity": "rim"
}, {
"map": ".relatedDocument.typeCode",
"identity": "cda"
}, {
"map": "DocumentReference.relatesTo.code",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/document-relationship-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentRelationshipType"
} ],
"description": "The type of relationship between documents."
},
"max": "1",
"id": "Composition.relatesTo.code",
"comment": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.",
"base": {
"max": "1",
"min": 1,
"path": "Composition.relatesTo.code"
},
"isSummary": false
}, {
"path": "Composition.relatesTo.target[x]",
"min": 1,
"definition": "The target composition/document of this relationship.",
"isModifier": false,
"short": "Target of the relationship",
"mapping": [ {
"map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id",
"identity": "rim"
}, {
"map": ".relatedDocument.id",
"identity": "cda"
}, {
"map": "DocumentReference.relatesTo.target",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "Identifier"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Composition" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.relatesTo.target[x]",
"base": {
"max": "1",
"min": 1,
"path": "Composition.relatesTo.target[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Composition.event",
"requirements": "Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.",
"min": 0,
"definition": "The clinical service, such as a colonoscopy or an appendectomy, being documented.",
"isModifier": false,
"short": "The clinical service(s) being documented",
"mapping": [ {
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']",
"identity": "rim"
}, {
"map": ".documentationOf.serviceEvent",
"identity": "cda"
}, {
"map": "DocumentReference.event",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.event",
"comment": "The event needs to be consistent with the type element, though can provide further information if desired.",
"base": {
"max": "*",
"min": 0,
"path": "Composition.event"
},
"isSummary": true
}, {
"path": "Composition.event.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.event.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.event.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.event.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.event.modifierExtension",
"min": 0,
"definition": "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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Composition.event.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Composition.event.code",
"min": 0,
"definition": "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 typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"isModifier": false,
"short": "Code(s) that apply to the event being documented",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": ".code",
"identity": "cda"
}, {
"map": "DocumentReference.event.code",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentEventType"
} ],
"description": "This list of codes represents the main clinical acts being documented."
},
"max": "*",
"id": "Composition.event.code",
"comment": "An event can further specialize the act inherent in the typeCode, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.",
"base": {
"max": "*",
"min": 0,
"path": "Composition.event.code"
},
"isSummary": true
}, {
"path": "Composition.event.period",
"min": 0,
"definition": "The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.",
"isModifier": false,
"short": "The period covered by the documentation",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": ".effectiveTime",
"identity": "cda"
}, {
"map": "DocumentReference.event.period",
"identity": "fhirdocumentreference"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.event.period",
"base": {
"max": "1",
"min": 0,
"path": "Composition.event.period"
},
"isSummary": true
}, {
"path": "Composition.event.detail",
"min": 0,
"definition": "The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.",
"isModifier": false,
"short": "The event(s) being documented",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "*",
"id": "Composition.event.detail",
"base": {
"max": "*",
"min": 0,
"path": "Composition.event.detail"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cmp-1",
"human": "A section must contain at least one of text, entries, or sub-sections",
"xpath": "exists(f:text) or exists(f:entry) or exists(f:section)",
"source": "Composition.section",
"severity": "error",
"expression": "text.exists() or entry.exists() or section.exists()"
}, {
"key": "cmp-2",
"human": "A section can only have an emptyReason if it is empty",
"xpath": "not(exists(f:emptyReason) and exists(f:entry))",
"source": "Composition.section",
"severity": "error",
"expression": "emptyReason.empty() or entry.empty()"
} ],
"path": "Composition.section",
"min": 1,
"definition": "The set of resource instances for the same type, e.g., device definition or LOINC codes, of the LIVD Mapping Publication.",
"isModifier": false,
"short": "Composition is broken into sections",
"mapping": [ {
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]",
"identity": "rim"
}, {
"map": ".component.structuredBody.component.section",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Section"
} ],
"max": "*",
"id": "Composition.section",
"base": {
"max": "*",
"min": 0,
"path": "Composition.section"
},
"isSummary": false
}, {
"path": "Composition.section.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.section.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.section.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.section.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.section.modifierExtension",
"min": 0,
"definition": "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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Composition.section.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "Composition.section.title",
"requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.",
"min": 1,
"definition": "The label for this particular section, e.g., Devices, LOINC Codes or Concept Maps.",
"isModifier": false,
"short": "Label for section (e.g. for Devices)",
"mapping": [ {
"map": "./title",
"identity": "rim"
}, {
"map": ".title",
"identity": "cda"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"alias": [ "header", "label", "caption" ],
"max": "1",
"id": "Composition.section.title",
"comment": "This will be used to organize CatalogEntries, Devices, Concept Maps, and Coding System resources.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.section.title"
},
"isSummary": false
}, {
"path": "Composition.section.code",
"requirements": "Provides computable standardized labels to topics within the document.",
"min": 1,
"definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.",
"isModifier": false,
"short": "devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions",
"mapping": [ {
"map": "./code",
"identity": "rim"
}, {
"map": ".code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/livd/ValueSet/livd-section-type",
"description": "The type of sections used in the LIVD Mapping Publication"
},
"max": "1",
"id": "Composition.section.code",
"comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.section.code"
},
"isSummary": false
}, {
"path": "Composition.section.author",
"requirements": "Identifies who is responsible for the content.",
"min": 0,
"definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.",
"isModifier": false,
"short": "Who and/or what authored the section",
"mapping": [ {
"map": "FiveWs.author",
"identity": "w5"
}, {
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]",
"identity": "rim"
}, {
"map": ".author.assignedAuthor",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "*",
"id": "Composition.section.author",
"base": {
"max": "*",
"min": 0,
"path": "Composition.section.author"
},
"isSummary": false
}, {
"path": "Composition.section.text",
"min": 0,
"definition": "A human-readable narrative that contains the attested content of the section, 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.",
"isModifier": false,
"short": "Text summary of the section, for human interpretation",
"mapping": [ {
"map": ".text",
"identity": "rim"
}, {
"map": ".text",
"identity": "cda"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.section.text",
"condition": [ "cmp-1" ],
"comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.section.text"
},
"isSummary": false
}, {
"path": "Composition.section.mode",
"requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.",
"min": 0,
"definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.",
"isModifier": false,
"short": "working | snapshot | changes",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/list-mode",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SectionMode"
} ],
"description": "The processing mode that applies to this section."
},
"max": "0",
"id": "Composition.section.mode",
"comment": "This element is labeled as a modifier because a change list must not be mis-understood as a complete list.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.section.mode"
},
"isSummary": false
}, {
"path": "Composition.section.orderedBy",
"requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.",
"min": 0,
"definition": "Specifies the order applied to the items in the section entries.",
"isModifier": false,
"short": "Order of section entries",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/list-order",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SectionEntryOrder"
} ],
"description": "What order applies to the items in the entry."
},
"max": "0",
"id": "Composition.section.orderedBy",
"comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.section.orderedBy"
},
"isSummary": false
}, {
"path": "Composition.section.entry",
"min": 1,
"definition": "A reference to the actual resource from which the narrative in the section is derived.",
"isModifier": false,
"short": "A reference to data that supports this section",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]",
"identity": "rim"
}, {
"map": ".entry",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "*",
"id": "Composition.section.entry",
"condition": [ "cmp-2" ],
"comment": "If there are no entries in the list, an emptyReason SHOULD be provided.",
"base": {
"max": "*",
"min": 0,
"path": "Composition.section.entry"
},
"isSummary": false
}, {
"path": "Composition.section.entry.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Composition.section.entry.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"path": "Composition.section.entry.extension",
"min": 0,
"definition": "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 manageable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Composition.section.entry.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Composition.section.entry.reference",
"min": 1,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"isModifier": false,
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.section.entry.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "Composition.section.entry.type",
"min": 0,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"isModifier": false,
"short": "Type the reference refers to (e.g. \"Patient\")",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "Composition.section.entry.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"path": "Composition.section.entry.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"isModifier": false,
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.section.entry.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "Composition.section.entry.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"isModifier": false,
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "Composition.section.entry.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "Composition.section.emptyReason",
"requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.",
"min": 0,
"definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.",
"isModifier": false,
"short": "Why the section is empty",
"mapping": [ {
"map": ".inboundRelationship[typeCode=SUBJ,code,
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SectionEmptyReason"
} ],
"description": "If a section is empty, why it is empty."
},
"max": "0",
"id": "Composition.section.emptyReason",
"condition": [ "cmp-2" ],
"comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.",
"base": {
"max": "1",
"min": 0,
"path": "Composition.section.emptyReason"
},
"isSummary": false
}, {
"path": "Composition.section.section",
"min": 0,
"definition": "A nested sub-section within this section.",
"isModifier": false,
"short": "Nested Section",
"mapping": [ {
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]",
"identity": "rim"
}, {
"map": ".component.section",
"identity": "cda"
} ],
"contentReference": "#Composition.section",
"mustSupport": false,
"max": "0",
"id": "Composition.section.section",
"condition": [ "cmp-1" ],
"comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.",
"base": {
"max": "*",
"min": 0,
"path": "Composition.section.section"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "dd03fe22-cba8-486b-9b3e-86d1fbbaa053",
"kind": "resource",
"url": "http://hl7.org/fhir/uv/livd/StructureDefinition/catalog-uv-livd",
"version": "0.1.0",
"differential": {
"element": [ {
"id": "Composition",
"path": "Composition",
"short": "LIVD Catalog",
"comment": "While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.",
"mapping": [ {
"map": "Event",
"identity": "workflow"
}, {
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct()]",
"identity": "rim"
}, {
"map": "ClinicalDocument",
"identity": "cda"
} ],
"isModifier": false,
"mustSupport": false
}, {
"path": "Composition.language",
"min": 1,
"definition": "Provides the language that the LIVD Mapping Publication is expressed in.",
"isModifier": false,
"short": "Publication Language",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.language",
"comment": "This is represented using BCP-47 (http://tools.ietf.org/html/bcp47) which includes RFC-5646."
}, {
"path": "Composition.identifier",
"min": 1,
"definition": "The logical identifier for the publication by the vendor.",
"isModifier": false,
"short": "Logical identifier of the LIVD Publication",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "Document.id / Document.setId",
"identity": "rim"
}, {
"map": ".setId",
"identity": "cda"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.identifier",
"comment": "See discussion in resource definition for how these relate."
}, {
"id": "Composition.identifier.use",
"max": "0",
"min": 0,
"path": "Composition.identifier.use",
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.identifier.type",
"max": "0",
"min": 0,
"path": "Composition.identifier.type",
"isModifier": false,
"mustSupport": false
}, {
"path": "Composition.identifier.system",
"min": 1,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"isModifier": false,
"short": "Publication Identifier Name Space",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.identifier.system"
}, {
"path": "Composition.identifier.value",
"min": 1,
"definition": "Provides the value of the identifier.",
"isModifier": false,
"short": "Publication Identifier Value",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.identifier.value"
}, {
"id": "Composition.identifier.period",
"max": "0",
"min": 0,
"path": "Composition.identifier.period",
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.identifier.assigner",
"max": "1",
"min": 1,
"path": "Composition.identifier.assigner",
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.identifier.assigner.reference",
"max": "0",
"min": 0,
"path": "Composition.identifier.assigner.reference",
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.identifier.assigner.identifier",
"max": "0",
"min": 0,
"path": "Composition.identifier.assigner.identifier",
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.identifier.assigner.display",
"max": "1",
"min": 1,
"path": "Composition.identifier.assigner.display",
"short": "Publication Vendor Name",
"definition": "The display name of the organization that issued/manages the identifier.",
"isModifier": false,
"mustSupport": false
}, {
"path": "Composition.status",
"requirements": "Need to be able to mark interim, amended, or withdrawn compositions or documents.",
"min": 1,
"definition": "The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.",
"isModifier": false,
"short": "preliminary | final | amended | entered-in-error",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "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(\"ReviseComposition\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\"",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.status",
"comment": "Support for final is required, while other statuses are optional.\n\nPrior statuses listed (not accurate currently?:\ninterim | final | withdrawn."
}, {
"path": "Composition.type",
"requirements": "Key metadata element describing the composition, used in searching/filtering.",
"min": 1,
"definition": "Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.",
"isModifier": false,
"short": "Kind of composition (LOINC if possible)",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": ".code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.type",
"comment": "For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding."
}, {
"id": "Composition.type.coding",
"max": "1",
"min": 1,
"path": "Composition.type.coding",
"type": [ {
"code": "Coding"
} ],
"definition": "Provides the LOINC Code for the LIVD Mapping Publication.",
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.type.coding.system",
"max": "1",
"min": 1,
"path": "Composition.type.coding.system",
"type": [ {
"code": "uri"
} ],
"short": "LOINC Coding System",
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.type.coding.version",
"max": "1",
"min": 1,
"path": "Composition.type.coding.version",
"type": [ {
"code": "string"
} ],
"short": "LOINC Code Version",
"isModifier": false,
"mustSupport": false
}, {
"path": "Composition.type.coding.code",
"min": 1,
"definition": "LOINC Code representing the LIVD Mapping Publication.",
"isModifier": false,
"short": "LIVD Mappipng Publication LOINC Code",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.type.coding.code"
}, {
"id": "Composition.type.coding.display",
"max": "1",
"min": 1,
"path": "Composition.type.coding.display",
"type": [ {
"code": "string"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.type.coding.userSelected",
"max": "0",
"min": 0,
"path": "Composition.type.coding.userSelected",
"type": [ {
"code": "boolean"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.type.text",
"max": "0",
"min": 0,
"path": "Composition.type.text",
"type": [ {
"code": "string"
} ],
"isModifier": false,
"mustSupport": false
}, {
"path": "Composition.category",
"requirements": "Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.",
"min": 0,
"definition": "A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.",
"isModifier": false,
"short": "Categorization of Composition",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.category",
"comment": "This is a metadata field from [XDS/MHD](http://wiki.ihe.net/index.php?title=Mobile_access_to_Health_Documents_(MHD))."
}, {
"path": "Composition.subject",
"requirements": "Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.",
"min": 0,
"definition": "Who or what the composition is about. The composition 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 livestock, or a set of patients that share a common exposure).",
"isModifier": false,
"short": "Who and/or what the composition is about",
"mapping": [ {
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]",
"identity": "rim"
}, {
"map": ".recordTarget",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.subject",
"comment": "For clinical documents, this is usually the patient."
}, {
"path": "Composition.encounter",
"requirements": "Provides context for the composition and supports searching.",
"min": 0,
"definition": "Describes the clinical encounter or type of care this documentation is associated with.",
"isModifier": false,
"short": "Context of the Composition",
"mapping": [ {
"map": "Event.context",
"identity": "workflow"
}, {
"map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])",
"identity": "rim"
}, {
"map": ".componentOf.encompassingEncounter",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.encounter"
}, {
"path": "Composition.date",
"requirements": "dateTime is used for tracking, organizing versions and searching.",
"min": 1,
"definition": "The date the LIVD Mapping Publication was published.",
"isModifier": false,
"short": "Composition editing time",
"mapping": [ {
"map": "Event.occurrence[x]",
"identity": "workflow"
}, {
"map": ".effectiveTime[type=\"TS\"]",
"identity": "rim"
}, {
"map": ".effectiveTime",
"identity": "cda"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.date",
"comment": "We do not need a separate effective date/time at this point."
}, {
"path": "Composition.author",
"requirements": "Identifies who is responsible for the content.",
"min": 1,
"definition": "Identifies who is responsible for the information in the LIVD Mapping Publication, not necessarily who typed it in.",
"isModifier": false,
"short": "Who and/or what authored the composition",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]",
"identity": "rim"
}, {
"map": ".author.assignedAuthor",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.author"
}, {
"id": "Composition.author.reference",
"max": "0",
"min": 0,
"path": "Composition.author.reference",
"type": [ {
"code": "string"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.author.identifier",
"max": "0",
"min": 0,
"path": "Composition.author.identifier",
"type": [ {
"code": "Identifier"
} ],
"isModifier": false,
"mustSupport": false
}, {
"path": "Composition.author.display",
"min": 1,
"definition": "The name of the vendor that authored the LIVD Mapping Publication.",
"isModifier": false,
"short": "Vendor Name",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.author.display"
}, {
"path": "Composition.title",
"min": 1,
"definition": "Official human-readable label for the LIVD Mapping Publication.",
"isModifier": false,
"short": "LIVD Mapping Publication Title",
"mapping": [ {
"map": "./title",
"identity": "rim"
}, {
"map": ".title",
"identity": "cda"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.title"
}, {
"path": "Composition.confidentiality",
"min": 0,
"definition": "The code specifying the level of confidentiality of the Composition.",
"isModifier": false,
"short": "As defined by affinity domain",
"mapping": [ {
"map": ".confidentialityCode",
"identity": "rim"
}, {
"map": ".confidentialityCode",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.confidentiality",
"comment": "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).\n\nThis element is labeled as a modifier because highly confidential documents must not be treated as if they are not."
}, {
"path": "Composition.attester",
"requirements": "Identifies responsibility for the accuracy of the composition content.",
"min": 0,
"definition": "A participant who has attested to the accuracy of the composition/document.",
"isModifier": false,
"short": "Attests to accuracy of composition",
"mapping": [ {
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]",
"identity": "rim"
}, {
"map": ".authenticator/.legalAuthenticator",
"identity": "cda"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.attester",
"comment": "Only list each attester once."
}, {
"path": "Composition.attester.mode",
"requirements": "Indicates the level of authority of the attestation.",
"min": 1,
"definition": "The type of attestation the authenticator offers.",
"isModifier": false,
"short": "personal | professional | legal | official",
"mapping": [ {
"map": "unique(./modeCode)",
"identity": "rim"
}, {
"map": "implied by .authenticator/.legalAuthenticator",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.attester.mode",
"comment": "Use more than one code where a single attester has more than one mode (professional and legal are often paired)."
}, {
"path": "Composition.attester.time",
"requirements": "Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).",
"min": 0,
"definition": "When the composition was attested by the party.",
"isModifier": false,
"short": "When the composition was attested",
"mapping": [ {
"map": "./time[type=\"TS\" and isNormalDatatype()]",
"identity": "rim"
}, {
"map": ".authenticator.time",
"identity": "cda"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.attester.time"
}, {
"path": "Composition.attester.party",
"requirements": "Identifies who has taken on the responsibility for accuracy of the composition content.",
"min": 0,
"definition": "Who attested the composition in the specified way.",
"isModifier": false,
"short": "Who attested the composition",
"mapping": [ {
"map": "./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()]",
"identity": "rim"
}, {
"map": ".authenticator.assignedEnttty",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.attester.party"
}, {
"path": "Composition.custodian",
"requirements": "Identifies where to go to find the current version, where to report issues, etc.",
"min": 0,
"definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.",
"isModifier": false,
"short": "Organization which maintains the composition",
"mapping": [ {
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]",
"identity": "rim"
}, {
"map": ".custodian.assignedCustodian",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.custodian",
"comment": "This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged."
}, {
"path": "Composition.relatesTo",
"min": 0,
"definition": "Relationships that this composition has with other compositions or documents that already exist.",
"isModifier": false,
"short": "Relationships to other compositions/documents",
"mapping": [ {
"map": ".outboundRelationship",
"identity": "rim"
}, {
"map": ".relatedDocument",
"identity": "cda"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.relatesTo",
"comment": "A document is a version specific composition."
}, {
"path": "Composition.relatesTo.code",
"min": 1,
"definition": "The type of relationship that this composition has with anther composition or document.",
"isModifier": false,
"short": "replaces | transforms | signs | appends",
"mapping": [ {
"map": ".outboundRelationship.typeCode",
"identity": "rim"
}, {
"map": ".relatedDocument.typeCode",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.relatesTo.code",
"comment": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document."
}, {
"path": "Composition.relatesTo.target[x]",
"min": 1,
"definition": "The target composition/document of this relationship.",
"isModifier": false,
"short": "Target of the relationship",
"mapping": [ {
"map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id",
"identity": "rim"
}, {
"map": ".relatedDocument.id",
"identity": "cda"
} ],
"type": [ {
"code": "Identifier"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Composition" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.relatesTo.target[x]"
}, {
"path": "Composition.event",
"requirements": "Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.",
"min": 0,
"definition": "The clinical service, such as a colonoscopy or an appendectomy, being documented.",
"isModifier": false,
"short": "The clinical service(s) being documented",
"mapping": [ {
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']",
"identity": "rim"
}, {
"map": ".documentationOf.serviceEvent",
"identity": "cda"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.event",
"comment": "The event needs to be consistent with the type element, though can provide further information if desired."
}, {
"path": "Composition.event.code",
"min": 0,
"definition": "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 typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"isModifier": false,
"short": "Code(s) that apply to the event being documented",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": ".code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "*",
"id": "Composition.event.code",
"comment": "An event can further specialize the act inherent in the typeCode, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries."
}, {
"path": "Composition.event.period",
"min": 0,
"definition": "The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.",
"isModifier": false,
"short": "The period covered by the documentation",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": ".effectiveTime",
"identity": "cda"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"max": "1",
"id": "Composition.event.period"
}, {
"path": "Composition.event.detail",
"min": 0,
"definition": "The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.",
"isModifier": false,
"short": "The event(s) being documented",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "*",
"id": "Composition.event.detail"
}, {
"path": "Composition.section",
"min": 1,
"definition": "The set of resource instances for the same type, e.g., device definition or LOINC codes, of the LIVD Mapping Publication.",
"isModifier": false,
"short": "Composition is broken into sections",
"mapping": [ {
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]",
"identity": "rim"
}, {
"map": ".component.structuredBody.component.section",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Section"
} ],
"max": "*",
"id": "Composition.section"
}, {
"path": "Composition.section.title",
"min": 1,
"definition": "The label for this particular section, e.g., Devices, LOINC Codes or Concept Maps.",
"isModifier": false,
"short": "Label for section (e.g. for Devices)",
"mapping": [ {
"map": "./title",
"identity": "rim"
}, {
"map": ".title",
"identity": "cda"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"alias": [ "header", "label", "caption" ],
"max": "1",
"id": "Composition.section.title",
"comment": "This will be used to organize CatalogEntries, Devices, Concept Maps, and Coding System resources."
}, {
"path": "Composition.section.code",
"requirements": "Provides computable standardized labels to topics within the document.",
"min": 1,
"definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.",
"isModifier": false,
"short": "devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions",
"mapping": [ {
"map": "./code",
"identity": "rim"
}, {
"map": ".code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/livd/ValueSet/livd-section-type",
"description": "The type of sections used in the LIVD Mapping Publication"
},
"max": "1",
"id": "Composition.section.code",
"comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code."
}, {
"path": "Composition.section.text",
"min": 0,
"definition": "A human-readable narrative that contains the attested content of the section, 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.",
"isModifier": false,
"short": "Text summary of the section, for human interpretation",
"mapping": [ {
"map": ".text",
"identity": "rim"
}, {
"map": ".text",
"identity": "cda"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.section.text",
"comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety."
}, {
"path": "Composition.section.mode",
"requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.",
"min": 0,
"definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.",
"isModifier": false,
"short": "working | snapshot | changes",
"mapping": [ {
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.section.mode",
"comment": "This element is labeled as a modifier because a change list must not be mis-understood as a complete list."
}, {
"path": "Composition.section.orderedBy",
"requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.",
"min": 0,
"definition": "Specifies the order applied to the items in the section entries.",
"isModifier": false,
"short": "Order of section entries",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.section.orderedBy",
"comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order."
}, {
"path": "Composition.section.entry",
"min": 1,
"definition": "A reference to the actual resource from which the narrative in the section is derived.",
"isModifier": false,
"short": "A reference to data that supports this section",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]",
"identity": "rim"
}, {
"map": ".entry",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "*",
"id": "Composition.section.entry",
"comment": "If there are no entries in the list, an emptyReason SHOULD be provided."
}, {
"id": "Composition.section.entry.reference",
"max": "1",
"min": 1,
"path": "Composition.section.entry.reference",
"type": [ {
"code": "string"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.section.entry.identifier",
"max": "0",
"min": 0,
"path": "Composition.section.entry.identifier",
"type": [ {
"code": "Identifier"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "Composition.section.entry.display",
"max": "0",
"min": 0,
"path": "Composition.section.entry.display",
"type": [ {
"code": "string"
} ],
"isModifier": false,
"mustSupport": false
}, {
"path": "Composition.section.emptyReason",
"requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.",
"min": 0,
"definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.",
"isModifier": false,
"short": "Why the section is empty",
"mapping": [ {
"map": ".inboundRelationship[typeCode=SUBJ,code,
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "0",
"id": "Composition.section.emptyReason",
"comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases."
}, {
"path": "Composition.section.section",
"min": 0,
"definition": "A nested sub-section within this section.",
"isModifier": false,
"short": "Nested Section",
"mapping": [ {
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]",
"identity": "rim"
}, {
"map": ".component.section",
"identity": "cda"
} ],
"contentReference": "#Composition.section",
"mustSupport": false,
"max": "0",
"id": "Composition.section.section",
"comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/orders/",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Composition"
}