{
"description": null,
"_filename": "DocumentReference.StructureDefinition.json",
"package_name": "digi.derm",
"date": "2024-04-08T15:09:09.5090824+00:00",
"derivation": "constraint",
"publisher": null,
"fhirVersion": "5.0.0",
"name": "DocumentReference",
"abstract": false,
"type": "DocumentReference",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.2",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/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",
"source": "http://hl7.org/fhir/StructureDefinition/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",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/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 human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "docRef-1",
"human": "facilityType SHALL only be present if context is not an encounter",
"source": "http://hl7.org/fhir/StructureDefinition/DocumentReference",
"severity": "warning",
"expression": "facilityType.empty() or context.where(resolve() is Encounter).empty()"
}, {
"key": "docRef-2",
"human": "practiceSetting SHALL only be present if context is not present",
"source": "http://hl7.org/fhir/StructureDefinition/DocumentReference",
"severity": "warning",
"expression": "practiceSetting.empty() or context.where(resolve() is Encounter).empty()"
} ],
"path": "DocumentReference",
"min": 0,
"definition": "A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this \"document\" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.",
"isModifier": false,
"short": "A reference to a document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Entity, Role, or Act",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "infrastructure.documents",
"identity": "w5"
}, {
"map": "when describing a Composition",
"identity": "fhircomposition"
}, {
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]",
"identity": "rim"
}, {
"map": "DocumentEntry",
"identity": "xds"
}, {
"map": "when describing a CDA",
"identity": "cda"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "*",
"id": "DocumentReference",
"comment": "Usually, this is used for documents other than those defined by FHIR.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference"
}
}, {
"path": "DocumentReference.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": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "DocumentReference.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.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",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.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",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "DocumentReference.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 its 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 its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "DocumentReference.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.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": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "0",
"id": "DocumentReference.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "DocumentReference.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "DocumentReference.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.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": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ident-1",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier",
"severity": "warning",
"expression": "value.exists()"
} ],
"path": "DocumentReference.identifier",
"requirements": "Document identifiers usually assigned by the source of the document, or other business identifiers such as XDS DocumentEntry.uniqueId and DocumentEntry.entryUUID. These identifiers are specific to this instance of the document.",
"min": 1,
"definition": "Other business identifiers associated with the document, including version independent identifiers.",
"isModifier": false,
"short": "Business identifiers for the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "Composition.identifier",
"identity": "fhircomposition"
}, {
"map": "TXA-12",
"identity": "v2"
}, {
"map": ".id / .setId",
"identity": "rim"
}, {
"map": "DocumentEntry.entryUUID, DocumentEntry.uniqueId",
"identity": "xds"
}, {
"map": "ClinicalDocument/id",
"identity": "cda"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "*",
"id": "DocumentReference.identifier",
"comment": "The structure and format of this identifier would be consistent with the specification corresponding to the format of the document. (e.g. for a DICOM standard document, a 64-character numeric UID; for an HL7 CDA format, the CDA Document Id root and extension).",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.version",
"min": 0,
"definition": "An explicitly assigned identifer of a variation of the content in the DocumentReference.",
"isModifier": false,
"short": "An explicitly assigned identifer of a variation of the content in the DocumentReference",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "FiveWs.version",
"identity": "w5"
}, {
"map": "Composition.version",
"identity": "fhircomposition"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "DocumentReference.version",
"comment": "While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "DocumentReference.basedOn",
"requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"min": 0,
"definition": "A procedure that is fulfilled in whole or in part by the creation of this media.",
"isModifier": false,
"short": "Procedure that caused this media to be created",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
}, {
"map": "DocumentEntry.referenceIdList",
"identity": "xds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Appointment", "http://hl7.org/fhir/StructureDefinition/AppointmentResponse", "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/Claim", "http://hl7.org/fhir/StructureDefinition/CommunicationRequest", "http://hl7.org/fhir/StructureDefinition/Contract", "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest", "http://hl7.org/fhir/StructureDefinition/DeviceRequest", "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/NutritionOrder", "http://hl7.org/fhir/StructureDefinition/RequestOrchestration", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/SupplyRequest", "http://hl7.org/fhir/StructureDefinition/VisionPrescription" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "fulfills" ],
"max": "0",
"id": "DocumentReference.basedOn",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.basedOn"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.status",
"fixedCode": "current",
"min": 1,
"definition": "The status of this document reference.",
"isModifier": true,
"short": "current | superseded | entered-in-error",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "TXA-19",
"identity": "v2"
}, {
"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(\"ReviseDocument\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\"",
"identity": "rim"
}, {
"map": "DocumentEntry.availabilityStatus",
"identity": "xds"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentReferenceStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The status of the document reference."
},
"max": "1",
"id": "DocumentReference.status",
"comment": "This is the status of the DocumentReference object, which might be independent from the docStatus element.\n\nThis element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.docStatus",
"min": 1,
"definition": "The status of the underlying document.",
"isModifier": false,
"short": "registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "Composition.status",
"identity": "fhircomposition"
}, {
"map": "TXA-17",
"identity": "v2"
}, {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/composition-status|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferredDocumentStatus"
} ],
"description": "Status of the underlying document."
},
"max": "1",
"id": "DocumentReference.docStatus",
"comment": "The document that is pointed to might be in various lifecycle states.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.docStatus"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.modality",
"min": 0,
"definition": "Imaging modality used. This may include both acquisition and non-acquisition modalities.",
"isModifier": false,
"short": "Imaging modality used",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImagingModality"
} ],
"description": "Type of acquired data in the instance."
},
"max": "0",
"id": "DocumentReference.modality",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.modality"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.type",
"min": 1,
"definition": "Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.",
"isModifier": false,
"short": "Kind of document (LOINC if possible)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "Composition.type",
"identity": "fhircomposition"
}, {
"map": "TXA-2",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "DocumentEntry.typeCode",
"identity": "xds"
}, {
"map": "ClinicalDocument/code/@code \n\nThe typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted.",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/doc-typecodes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentType"
} ],
"description": "Precise type of clinical document."
},
"max": "1",
"id": "DocumentReference.type",
"comment": "Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.type"
},
"isSummary": true
}, {
"path": "DocumentReference.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.type.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cod-1",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"source": "http://hl7.org/fhir/StructureDefinition/Coding",
"severity": "warning",
"expression": "code.exists().not() implies display.exists().not()"
} ],
"path": "DocumentReference.type.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.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": "DocumentReference.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.type.coding.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.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.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "DocumentReference.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.type.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"id": "DocumentReference.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.type.coding.code",
"fixedCode": "820091000000101",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "DocumentReference.type.coding.code",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.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": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "DocumentReference.type.coding.display",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.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).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"max": "0",
"id": "DocumentReference.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.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.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.category",
"min": 1,
"definition": "A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.",
"isModifier": false,
"short": "Categorization of document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "Composition.category",
"identity": "fhircomposition"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code",
"identity": "rim"
}, {
"map": "DocumentEntry.classCode",
"identity": "xds"
}, {
"map": "Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/referenced-item-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferencedItemCategory"
} ],
"description": "High-level kind of document at a macro level."
},
"alias": [ "class", "classCode" ],
"max": "1",
"id": "DocumentReference.category",
"comment": "Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.category"
},
"isSummary": true
}, {
"path": "DocumentReference.category.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.category.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.category.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.category.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cod-1",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"source": "http://hl7.org/fhir/StructureDefinition/Coding",
"severity": "warning",
"expression": "code.exists().not() implies display.exists().not()"
} ],
"path": "DocumentReference.category.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.category.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": "DocumentReference.category.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.category.coding.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.category.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.category.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.category.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.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "DocumentReference.category.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.category.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"id": "DocumentReference.category.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.category.coding.code",
"fixedCode": "820241000000102",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "DocumentReference.category.coding.code",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.category.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": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "DocumentReference.category.coding.display",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.category.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).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"max": "0",
"id": "DocumentReference.category.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.category.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.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.category.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "DocumentReference.subject",
"min": 1,
"definition": "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).",
"isModifier": false,
"short": "Who/what is the subject of the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "Composition.subject",
"identity": "fhircomposition"
}, {
"map": "PID-3 (No standard way to define a Practitioner or Group subject in HL7 V2 MDM message)",
"identity": "v2"
}, {
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]",
"identity": "rim"
}, {
"map": "DocumentEntry.patientId",
"identity": "xds"
}, {
"map": "ClinicalDocument/recordTarget/",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.subject",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.subject"
},
"isSummary": true
}, {
"path": "DocumentReference.subject.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.subject.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.subject.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.subject.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.subject.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.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "DocumentReference.subject.reference",
"condition": [ "ref-2", "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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.subject.type",
"min": 1,
"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).",
"short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources",
"fixedUri": "Patient",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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/tools/StructureDefinition/binding-definition",
"valueString": "Aa resource (or, for logical models, the URI of the logical model)."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "DocumentReference.subject.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 known RESTful URL) or by resolving the target of the reference.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ident-1",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier",
"severity": "warning",
"expression": "value.exists()"
} ],
"path": "DocumentReference.subject.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.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "DocumentReference.subject.identifier",
"condition": [ "ref-2" ],
"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).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.subject.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.subject.display",
"condition": [ "ref-2" ],
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "DocumentReference.context",
"min": 1,
"definition": "Describes the clinical encounter or type of care that the document content is associated with.",
"isModifier": false,
"short": "Context of the document content",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Event.encounter",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "Composition.encounter",
"identity": "fhircomposition"
}, {
"map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Appointment", "http://hl7.org/fhir/StructureDefinition/Encounter", "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.context",
"condition": [ "docRef-1", "docRef-2" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.context"
},
"isSummary": false
}, {
"path": "DocumentReference.context.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.context.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.context.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.context.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.context.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.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "DocumentReference.context.reference",
"condition": [ "ref-2", "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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.context.type",
"min": 1,
"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).",
"short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources",
"fixedUri": "Encounter",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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/tools/StructureDefinition/binding-definition",
"valueString": "Aa resource (or, for logical models, the URI of the logical model)."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "DocumentReference.context.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 known RESTful URL) or by resolving the target of the reference.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ident-1",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier",
"severity": "warning",
"expression": "value.exists()"
} ],
"path": "DocumentReference.context.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.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "DocumentReference.context.identifier",
"condition": [ "ref-2" ],
"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).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.context.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.context.display",
"condition": [ "ref-2" ],
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.event",
"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 type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"isModifier": false,
"short": "Main clinical acts documented",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.event.detail",
"identity": "fhircomposition"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "DocumentEntry.referenceIdList",
"identity": "xds"
} ],
"type": [ {
"code": "CodeableReference"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"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": "0",
"id": "DocumentReference.event",
"comment": "An event can further specialize the act inherent in the type, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.event"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.bodySite",
"min": 0,
"definition": "The anatomic structures included in the document.",
"isModifier": false,
"short": "Body part included",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".targetSiteCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/BodyStructure" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/body-site",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Codes describing anatomical locations. May include laterality."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
} ],
"description": "SNOMED CT Body site concepts"
},
"max": "0",
"id": "DocumentReference.bodySite",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.bodySite"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.facilityType",
"min": 0,
"definition": "The kind of facility where the patient was seen.",
"isModifier": false,
"short": "Kind of facility where patient was seen",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "usually from a mapping to a local ValueSet",
"identity": "fhircomposition"
}, {
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code",
"identity": "rim"
}, {
"map": "DocumentEntry.healthcareFacilityTypeCode",
"identity": "xds"
}, {
"map": "usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/c80-facilitycodes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80FacilityType"
} ],
"description": "XDS Facility Type."
},
"max": "0",
"id": "DocumentReference.facilityType",
"condition": [ "docRef-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.facilityType"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.practiceSetting",
"requirements": "This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.",
"min": 0,
"definition": "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.",
"isModifier": false,
"short": "Additional details about where the content was created (e.g. clinical specialty)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "usually from a mapping to a local ValueSet",
"identity": "fhircomposition"
}, {
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code",
"identity": "rim"
}, {
"map": "DocumentEntry.practiceSettingCode",
"identity": "xds"
}, {
"map": "usually from a mapping to a local ValueSet",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80PracticeSetting"
} ],
"description": "Additional details about where the content was created (e.g. clinical specialty)."
},
"max": "0",
"id": "DocumentReference.practiceSetting",
"condition": [ "docRef-2" ],
"comment": "This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.practiceSetting"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower or equal value than end",
"source": "http://hl7.org/fhir/StructureDefinition/Period",
"severity": "error",
"expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())"
} ],
"path": "DocumentReference.period",
"min": 0,
"definition": "The time period over which the service that is described by the document was provided.",
"isModifier": false,
"short": "Time of service that is being documented",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
}, {
"map": "Composition.event.period",
"identity": "fhircomposition"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime",
"identity": "xds"
}, {
"map": "ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/low/\n@value --> ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/high/\n@value",
"identity": "cda"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "DocumentReference.period",
"comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.date",
"min": 1,
"definition": "When the document reference was created.",
"isModifier": false,
"short": "When this document reference was created",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Event.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.recorded",
"identity": "w5"
}, {
"map": "Composition.date",
"identity": "fhircomposition"
}, {
"map": ".availabilityTime[type=\"TS\"]",
"identity": "rim"
} ],
"type": [ {
"code": "instant"
} ],
"mustSupport": false,
"alias": [ "indexed" ],
"max": "1",
"id": "DocumentReference.date",
"comment": "Referencing/indexing time is used for tracking, organizing versions and searching.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.date"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "DocumentReference.author",
"min": 1,
"definition": "Identifies who is responsible for adding the information to the document.",
"isModifier": false,
"short": "Who and/or what authored the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "Composition.author",
"identity": "fhircomposition"
}, {
"map": "TXA-9 (No standard way to indicate a Device in HL7 V2 MDM message)",
"identity": "v2"
}, {
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]",
"identity": "rim"
}, {
"map": "DocumentEntry.author",
"identity": "xds"
}, {
"map": "ClinicalDocument/author",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/CareTeam" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.author",
"comment": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.author"
},
"isSummary": true
}, {
"path": "DocumentReference.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.author.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.author.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.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "DocumentReference.author.reference",
"condition": [ "ref-2", "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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.author.type",
"min": 1,
"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).",
"short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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/tools/StructureDefinition/binding-definition",
"valueString": "Aa resource (or, for logical models, the URI of the logical model)."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "DocumentReference.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 known RESTful URL) or by resolving the target of the reference.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ident-1",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier",
"severity": "warning",
"expression": "value.exists()"
} ],
"path": "DocumentReference.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.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "DocumentReference.author.identifier",
"condition": [ "ref-2" ],
"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).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.author.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.author.display",
"condition": [ "ref-2" ],
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.attester",
"requirements": "Identifies responsibility for the accuracy of the document content.",
"min": 0,
"definition": "A participant who has authenticated the accuracy of the document.",
"isModifier": false,
"short": "Attests to accuracy of the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "Composition.attester",
"identity": "fhircomposition"
}, {
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]",
"identity": "rim"
}, {
"map": "DocumentEntry.legalAuthenticator",
"identity": "xds"
}, {
"map": ".authenticator/.legalAuthenticator",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "DocumentReference.attester",
"comment": "Only list each attester once.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.attester"
},
"isSummary": false
}, {
"path": "DocumentReference.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.attester.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.attester.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.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": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "Composition.attester.mode",
"identity": "fhircomposition"
}, {
"map": "unique(./modeCode)",
"identity": "rim"
}, {
"map": "implied by .authenticator/.legalAuthenticator",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/composition-attestation-mode",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentAttestationMode"
} ],
"description": "The way in which a person authenticated a document."
},
"max": "1",
"id": "DocumentReference.attester.mode",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.attester.mode"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.attester.time",
"requirements": "Identifies when the information in the document was deemed accurate. (Things may have changed since then.).",
"min": 0,
"definition": "When the document was attested by the party.",
"isModifier": false,
"short": "When the document was attested",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.attester.time",
"identity": "fhircomposition"
}, {
"map": "./time[type=\"TS\" and isNormalDatatype()]",
"identity": "rim"
}, {
"map": ".authenticator.time",
"identity": "cda"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "DocumentReference.attester.time",
"comment": "UTC offset is allowed for dates and partial dates",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.attester.time"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "DocumentReference.attester.party",
"requirements": "Identifies who has taken on the responsibility for accuracy of the document content.",
"min": 0,
"definition": "Who attested the document in the specified way.",
"isModifier": false,
"short": "Who attested the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": "Composition.attester.party",
"identity": "fhircomposition"
}, {
"map": "TXA-10",
"identity": "v2"
}, {
"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/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.attester.party",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.attester.party"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "DocumentReference.custodian",
"min": 0,
"definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.",
"isModifier": false,
"short": "Organization which maintains the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "Composition.custodian",
"identity": "fhircomposition"
}, {
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "DocumentReference.custodian",
"comment": "Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.custodian"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.relatesTo",
"min": 0,
"definition": "Relationships that this document has with other document references that already exist.",
"isModifier": false,
"short": "Relationships to other documents",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.relatesTo",
"identity": "fhircomposition"
}, {
"map": ".outboundRelationship",
"identity": "rim"
}, {
"map": "DocumentEntry Associations",
"identity": "xds"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "DocumentReference.relatesTo",
"comment": "This element is labeled as a modifier because documents that append to other documents are incomplete on their own.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.relatesTo"
},
"isSummary": true
}, {
"path": "DocumentReference.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.relatesTo.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.relatesTo.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.relatesTo.code",
"min": 1,
"definition": "The type of relationship that this document has with anther document.",
"isModifier": false,
"short": "The relationship type with another document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "Composition.relatesTo.type",
"identity": "fhircomposition"
}, {
"map": ".outboundRelationship.typeCode",
"identity": "rim"
}, {
"map": "DocumentEntry Associations type",
"identity": "xds"
}, {
"map": "ClinicalDocument/relatedDocument/typeCode",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "extensible",
"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 the documents."
},
"max": "1",
"id": "DocumentReference.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": "DocumentReference.relatesTo.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "DocumentReference.relatesTo.target",
"min": 1,
"definition": "The target document of this relationship.",
"isModifier": false,
"short": "Target of the relationship",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Composition.relatesTo.resourceReference",
"identity": "fhircomposition"
}, {
"map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id",
"identity": "rim"
}, {
"map": "DocumentEntry Associations reference",
"identity": "xds"
}, {
"map": "ClinicalDocument/relatedDocument/parentDocument",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.relatesTo.target",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.relatesTo.target"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.description",
"requirements": "Helps humans to assess whether the document is of interest.",
"min": 0,
"definition": "Human-readable description of the source document.",
"isModifier": false,
"short": "Human-readable description",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "TXA-25",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text",
"identity": "rim"
}, {
"map": "DocumentEntry.comments",
"identity": "xds"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"max": "0",
"id": "DocumentReference.description",
"comment": "What the document is about, a terse summary of the document.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.description"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.securityLabel",
"requirements": "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.",
"min": 0,
"definition": "A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.",
"isModifier": false,
"short": "Document security-tags",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "Bundle.meta.security",
"identity": "fhircomposition"
}, {
"map": "TXA-18",
"identity": "v2"
}, {
"map": ".confidentialityCode",
"identity": "rim"
}, {
"map": "DocumentEntry.confidentialityCode",
"identity": "xds"
}, {
"map": "ClinicalDocument/confidentialityCode/@code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/security-label-examples",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Example Security Labels from the Healthcare Privacy and Security Classification System."
},
"max": "0",
"id": "DocumentReference.securityLabel",
"comment": "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n\nIn the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.securityLabel"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content",
"requirements": "Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats.",
"min": 3,
"definition": "The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.",
"isModifier": false,
"short": "Document referenced",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Bundle(Composition+*)",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "profile.value.code",
"type": "value"
} ]
},
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "3",
"id": "DocumentReference.content",
"comment": "content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.",
"base": {
"max": "*",
"min": 1,
"path": "DocumentReference.content"
},
"isSummary": true
}, {
"path": "DocumentReference.content.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.content.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "att-1",
"human": "If the Attachment has data, it SHALL have a contentType",
"source": "http://hl7.org/fhir/StructureDefinition/Attachment",
"severity": "error",
"expression": "data.empty() or contentType.exists()"
} ],
"path": "DocumentReference.content.attachment",
"min": 1,
"definition": "The document or URL of the document along with critical metadata to prove content has integrity.",
"isModifier": false,
"short": "Where to access the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED/RP",
"identity": "v2"
}, {
"map": "ED",
"identity": "rim"
}, {
"map": "Composition.language, \nComposition.title, \nComposition.date",
"identity": "fhircomposition"
}, {
"map": "TXA-3 for mime type",
"identity": "v2"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime",
"identity": "xds"
}, {
"map": "ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date",
"identity": "cda"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.content.attachment",
"comment": "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Signed Procedure Consent\".",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.content.attachment"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile",
"min": 0,
"definition": "An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.",
"isModifier": false,
"short": "Content profile rules for the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.meta.profile",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.formatCode",
"identity": "xds"
}, {
"map": "derived from the IHE Profile or Implementation Guide templateID",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "format", "formatCode" ],
"max": "*",
"id": "DocumentReference.content.profile",
"comment": "Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.\n\nFor FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.content.profile"
},
"isSummary": true
}, {
"path": "DocumentReference.content.profile.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content.profile.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content.profile.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.content.profile.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x]",
"min": 1,
"definition": "Code|uri|canonical.",
"isModifier": false,
"short": "Code|uri|canonical",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.meta.profile",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.formatCode",
"identity": "xds"
}, {
"map": "derived from the IHE Profile or Implementation Guide templateID",
"identity": "cda"
} ],
"type": [ {
"code": "Coding"
}, {
"code": "uri"
}, {
"code": "canonical"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentFormat"
} ],
"description": "Document Format Codes."
},
"max": "1",
"id": "DocumentReference.content.profile.value[x]",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.content.profile.value[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content",
"requirements": "Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats.",
"min": 1,
"definition": "The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.",
"isModifier": false,
"short": "Document referenced",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Bundle(Composition+*)",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"sliceName": "thumbnail",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.content:thumbnail",
"comment": "content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.",
"base": {
"max": "*",
"min": 1,
"path": "DocumentReference.content"
},
"isSummary": true
}, {
"path": "DocumentReference.content.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:thumbnail.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:thumbnail.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.content:thumbnail.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "att-1",
"human": "If the Attachment has data, it SHALL have a contentType",
"source": "http://hl7.org/fhir/StructureDefinition/Attachment",
"severity": "error",
"expression": "data.empty() or contentType.exists()"
} ],
"path": "DocumentReference.content.attachment",
"min": 1,
"definition": "The document or URL of the document along with critical metadata to prove content has integrity.",
"isModifier": false,
"short": "Where to access the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED/RP",
"identity": "v2"
}, {
"map": "ED",
"identity": "rim"
}, {
"map": "Composition.language, \nComposition.title, \nComposition.date",
"identity": "fhircomposition"
}, {
"map": "TXA-3 for mime type",
"identity": "v2"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime",
"identity": "xds"
}, {
"map": "ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date",
"identity": "cda"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.content:thumbnail.attachment",
"comment": "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Signed Procedure Consent\".",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.content.attachment"
},
"isSummary": true
}, {
"path": "DocumentReference.content.attachment.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:thumbnail.attachment.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.attachment.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:thumbnail.attachment.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.contentType",
"fixedCode": "image/jpeg",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 1,
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"short": "Mime type of the content, with charset etc.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used",
"identity": "v2"
}, {
"map": "./mediaType, ./charset",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)"
},
"max": "1",
"id": "DocumentReference.content:thumbnail.attachment.contentType",
"condition": [ "att-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"example": [ {
"label": "General",
"valueCode": "text/plain; charset=UTF-8, image/png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.contentType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.language",
"requirements": "Users need to be able to choose between the languages in a set of attachments.",
"min": 0,
"definition": "The human language of the content. The value can be any valid value according to BCP 47.",
"short": "Human language of the content (BCP-47)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "./language",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "IETF language tag for a human language."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language."
},
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.language",
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"example": [ {
"label": "General",
"valueCode": "en-AU"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.language"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.data",
"requirements": "The data needs to able to be transmitted inline.",
"min": 0,
"definition": "The actual data of the attachment - a sequence of bytes, base64 encoded.",
"short": "Data inline, base64ed",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED.5",
"identity": "v2"
}, {
"map": "./data",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.data",
"condition": [ "att-1" ],
"comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.data"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.url",
"requirements": "The data needs to be transmitted by reference.",
"min": 0,
"definition": "A location where the data can be accessed.",
"short": "Uri where the data can be found",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "RP.1+RP.2 - if they refer to a URL (see v2.6)",
"identity": "v2"
}, {
"map": "./reference/literal",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.url",
"comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"example": [ {
"label": "General",
"valueUrl": "http://www.acme.com/logo-small.png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.url"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.size",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min": 0,
"definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"short": "Number of bytes of content (if url provided)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "integer64"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.size",
"comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.size"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.hash",
"requirements": "Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).",
"min": 0,
"definition": "The calculated hash of the data using SHA-1. Represented using base64.",
"short": "Hash of the data (sha-1, base64ed)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.hash",
"comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.hash"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.title",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min": 0,
"definition": "A label or set of text to display in place of the data.",
"short": "Label to display in place of the data",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "./title/data",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.title",
"comment": "May sometimes be derived from the source filename.",
"example": [ {
"label": "General",
"valueString": "Official Corporate Logo"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.title"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.creation",
"requirements": "This is often tracked as an integrity issue for use of the attachment.",
"min": 0,
"definition": "The date that the attachment was first created.",
"short": "Date attachment was first created",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.creation",
"comment": "UTC offset is allowed for dates and partial dates",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.creation"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.height",
"min": 0,
"definition": "Height of the image in pixels (photo/video).",
"short": "Height of the image in pixels (photo/video)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.height",
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.height"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.width",
"min": 0,
"definition": "Width of the image in pixels (photo/video).",
"short": "Width of the image in pixels (photo/video)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.width",
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.width"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.frames",
"min": 0,
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"short": "Number of frames if > 1 (photo)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.frames",
"comment": "if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.frames"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.duration",
"min": 0,
"definition": "The duration of the recording in seconds - for audio and video.",
"short": "Length in seconds (audio / video)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.duration",
"comment": "The duration might differ from occurrencePeriod if recording was paused.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.duration"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.pages",
"min": 0,
"definition": "The number of pages when printed.",
"short": "Number of printed pages",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.attachment.pages",
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.pages"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile",
"min": 1,
"definition": "An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.",
"isModifier": false,
"short": "Content profile rules for the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.meta.profile",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.formatCode",
"identity": "xds"
}, {
"map": "derived from the IHE Profile or Implementation Guide templateID",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "format", "formatCode" ],
"max": "1",
"id": "DocumentReference.content:thumbnail.profile",
"comment": "Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.\n\nFor FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.content.profile"
},
"isSummary": true
}, {
"path": "DocumentReference.content.profile.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:thumbnail.profile.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:thumbnail.profile.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.content:thumbnail.profile.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x]",
"min": 1,
"definition": "Code|uri|canonical.",
"isModifier": false,
"short": "Code|uri|canonical",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.meta.profile",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.formatCode",
"identity": "xds"
}, {
"map": "derived from the IHE Profile or Implementation Guide templateID",
"identity": "cda"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentFormat"
} ],
"description": "Document Format Codes."
},
"max": "1",
"id": "DocumentReference.content:thumbnail.profile.value[x]",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.content.profile.value[x]"
},
"isSummary": true
}, {
"path": "DocumentReference.content.profile.value[x].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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:thumbnail.profile.value[x].id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.value[x].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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:thumbnail.profile.value[x].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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].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.",
"short": "Identity of the terminology system",
"fixedUri": "https://api.ndp.scot/storage/digital-dermatology/CodeSystem/image-size",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "DocumentReference.content:thumbnail.profile.value[x].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 be an absolute reference to some definition that establishes the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.profile.value[x].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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].code",
"fixedCode": "thumbnail",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "DocumentReference.content:thumbnail.profile.value[x].code",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.profile.value[x].display",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].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).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"max": "0",
"id": "DocumentReference.content:thumbnail.profile.value[x].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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content",
"requirements": "Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats.",
"min": 1,
"definition": "The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.",
"isModifier": false,
"short": "Document referenced",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Bundle(Composition+*)",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"sliceName": "high_resolution",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.content:high_resolution",
"comment": "content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.",
"base": {
"max": "*",
"min": 1,
"path": "DocumentReference.content"
},
"isSummary": true
}, {
"path": "DocumentReference.content.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:high_resolution.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:high_resolution.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.content:high_resolution.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "att-1",
"human": "If the Attachment has data, it SHALL have a contentType",
"source": "http://hl7.org/fhir/StructureDefinition/Attachment",
"severity": "error",
"expression": "data.empty() or contentType.exists()"
} ],
"path": "DocumentReference.content.attachment",
"min": 1,
"definition": "The document or URL of the document along with critical metadata to prove content has integrity.",
"isModifier": false,
"short": "Where to access the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED/RP",
"identity": "v2"
}, {
"map": "ED",
"identity": "rim"
}, {
"map": "Composition.language, \nComposition.title, \nComposition.date",
"identity": "fhircomposition"
}, {
"map": "TXA-3 for mime type",
"identity": "v2"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime",
"identity": "xds"
}, {
"map": "ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date",
"identity": "cda"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.content:high_resolution.attachment",
"comment": "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Signed Procedure Consent\".",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.content.attachment"
},
"isSummary": true
}, {
"path": "DocumentReference.content.attachment.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:high_resolution.attachment.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.attachment.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:high_resolution.attachment.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.contentType",
"fixedCode": "image/jpeg",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 1,
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"short": "Mime type of the content, with charset etc.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used",
"identity": "v2"
}, {
"map": "./mediaType, ./charset",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)"
},
"max": "1",
"id": "DocumentReference.content:high_resolution.attachment.contentType",
"condition": [ "att-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"example": [ {
"label": "General",
"valueCode": "text/plain; charset=UTF-8, image/png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.contentType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.language",
"requirements": "Users need to be able to choose between the languages in a set of attachments.",
"min": 0,
"definition": "The human language of the content. The value can be any valid value according to BCP 47.",
"short": "Human language of the content (BCP-47)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "./language",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "IETF language tag for a human language."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language."
},
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.language",
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"example": [ {
"label": "General",
"valueCode": "en-AU"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.language"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.data",
"requirements": "The data needs to able to be transmitted inline.",
"min": 0,
"definition": "The actual data of the attachment - a sequence of bytes, base64 encoded.",
"short": "Data inline, base64ed",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED.5",
"identity": "v2"
}, {
"map": "./data",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.data",
"condition": [ "att-1" ],
"comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.data"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.url",
"requirements": "The data needs to be transmitted by reference.",
"min": 0,
"definition": "A location where the data can be accessed.",
"short": "Uri where the data can be found",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "RP.1+RP.2 - if they refer to a URL (see v2.6)",
"identity": "v2"
}, {
"map": "./reference/literal",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.url",
"comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"example": [ {
"label": "General",
"valueUrl": "http://www.acme.com/logo-small.png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.url"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.size",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min": 0,
"definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"short": "Number of bytes of content (if url provided)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "integer64"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.size",
"comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.size"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.hash",
"requirements": "Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).",
"min": 0,
"definition": "The calculated hash of the data using SHA-1. Represented using base64.",
"short": "Hash of the data (sha-1, base64ed)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.hash",
"comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.hash"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.title",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min": 0,
"definition": "A label or set of text to display in place of the data.",
"short": "Label to display in place of the data",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "./title/data",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.title",
"comment": "May sometimes be derived from the source filename.",
"example": [ {
"label": "General",
"valueString": "Official Corporate Logo"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.title"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.creation",
"requirements": "This is often tracked as an integrity issue for use of the attachment.",
"min": 0,
"definition": "The date that the attachment was first created.",
"short": "Date attachment was first created",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.creation",
"comment": "UTC offset is allowed for dates and partial dates",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.creation"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.height",
"min": 0,
"definition": "Height of the image in pixels (photo/video).",
"short": "Height of the image in pixels (photo/video)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.height",
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.height"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.width",
"min": 0,
"definition": "Width of the image in pixels (photo/video).",
"short": "Width of the image in pixels (photo/video)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.width",
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.width"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.frames",
"min": 0,
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"short": "Number of frames if > 1 (photo)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.frames",
"comment": "if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.frames"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.duration",
"min": 0,
"definition": "The duration of the recording in seconds - for audio and video.",
"short": "Length in seconds (audio / video)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.duration",
"comment": "The duration might differ from occurrencePeriod if recording was paused.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.duration"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.pages",
"min": 0,
"definition": "The number of pages when printed.",
"short": "Number of printed pages",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.attachment.pages",
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.pages"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile",
"min": 1,
"definition": "An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.",
"isModifier": false,
"short": "Content profile rules for the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.meta.profile",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.formatCode",
"identity": "xds"
}, {
"map": "derived from the IHE Profile or Implementation Guide templateID",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "format", "formatCode" ],
"max": "1",
"id": "DocumentReference.content:high_resolution.profile",
"comment": "Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.\n\nFor FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.content.profile"
},
"isSummary": true
}, {
"path": "DocumentReference.content.profile.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:high_resolution.profile.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:high_resolution.profile.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.content:high_resolution.profile.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x]",
"min": 1,
"definition": "Code|uri|canonical.",
"isModifier": false,
"short": "Code|uri|canonical",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.meta.profile",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.formatCode",
"identity": "xds"
}, {
"map": "derived from the IHE Profile or Implementation Guide templateID",
"identity": "cda"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentFormat"
} ],
"description": "Document Format Codes."
},
"max": "1",
"id": "DocumentReference.content:high_resolution.profile.value[x]",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.content.profile.value[x]"
},
"isSummary": true
}, {
"path": "DocumentReference.content.profile.value[x].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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:high_resolution.profile.value[x].id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.value[x].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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:high_resolution.profile.value[x].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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].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.",
"short": "Identity of the terminology system",
"fixedUri": "https://api.ndp.scot/storage/digital-dermatology/CodeSystem/image-size",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "DocumentReference.content:high_resolution.profile.value[x].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 be an absolute reference to some definition that establishes the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.profile.value[x].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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].code",
"fixedCode": "high_resolution",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "DocumentReference.content:high_resolution.profile.value[x].code",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.profile.value[x].display",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].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).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"max": "0",
"id": "DocumentReference.content:high_resolution.profile.value[x].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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content",
"requirements": "Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats.",
"min": 1,
"definition": "The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.",
"isModifier": false,
"short": "Document referenced",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Bundle(Composition+*)",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"sliceName": "original",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.content:original",
"comment": "content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.",
"base": {
"max": "*",
"min": 1,
"path": "DocumentReference.content"
},
"isSummary": true
}, {
"path": "DocumentReference.content.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:original.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:original.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.content:original.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "att-1",
"human": "If the Attachment has data, it SHALL have a contentType",
"source": "http://hl7.org/fhir/StructureDefinition/Attachment",
"severity": "error",
"expression": "data.empty() or contentType.exists()"
} ],
"path": "DocumentReference.content.attachment",
"min": 1,
"definition": "The document or URL of the document along with critical metadata to prove content has integrity.",
"isModifier": false,
"short": "Where to access the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED/RP",
"identity": "v2"
}, {
"map": "ED",
"identity": "rim"
}, {
"map": "Composition.language, \nComposition.title, \nComposition.date",
"identity": "fhircomposition"
}, {
"map": "TXA-3 for mime type",
"identity": "v2"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime",
"identity": "xds"
}, {
"map": "ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date",
"identity": "cda"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "DocumentReference.content:original.attachment",
"comment": "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Signed Procedure Consent\".",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.content.attachment"
},
"isSummary": true
}, {
"path": "DocumentReference.content.attachment.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:original.attachment.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.attachment.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:original.attachment.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.contentType",
"fixedCode": "image/jpeg",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 1,
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"short": "Mime type of the content, with charset etc.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used",
"identity": "v2"
}, {
"map": "./mediaType, ./charset",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The mime type of an attachment. Any valid mime type is allowed."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)"
},
"max": "1",
"id": "DocumentReference.content:original.attachment.contentType",
"condition": [ "att-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"example": [ {
"label": "General",
"valueCode": "text/plain; charset=UTF-8, image/png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.contentType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.language",
"requirements": "Users need to be able to choose between the languages in a set of attachments.",
"min": 0,
"definition": "The human language of the content. The value can be any valid value according to BCP 47.",
"short": "Human language of the content (BCP-47)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "./language",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "IETF language tag for a human language."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language."
},
"max": "0",
"id": "DocumentReference.content:original.attachment.language",
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"example": [ {
"label": "General",
"valueCode": "en-AU"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.language"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.data",
"requirements": "The data needs to able to be transmitted inline.",
"min": 0,
"definition": "The actual data of the attachment - a sequence of bytes, base64 encoded.",
"short": "Data inline, base64ed",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED.5",
"identity": "v2"
}, {
"map": "./data",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.data",
"condition": [ "att-1" ],
"comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.data"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.url",
"requirements": "The data needs to be transmitted by reference.",
"min": 0,
"definition": "A location where the data can be accessed.",
"short": "Uri where the data can be found",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "RP.1+RP.2 - if they refer to a URL (see v2.6)",
"identity": "v2"
}, {
"map": "./reference/literal",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.url",
"comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"example": [ {
"label": "General",
"valueUrl": "http://www.acme.com/logo-small.png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.url"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.size",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min": 0,
"definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"short": "Number of bytes of content (if url provided)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "integer64"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.size",
"comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.size"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.hash",
"requirements": "Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).",
"min": 0,
"definition": "The calculated hash of the data using SHA-1. Represented using base64.",
"short": "Hash of the data (sha-1, base64ed)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.hash",
"comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.hash"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.title",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min": 0,
"definition": "A label or set of text to display in place of the data.",
"short": "Label to display in place of the data",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "./title/data",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.title",
"comment": "May sometimes be derived from the source filename.",
"example": [ {
"label": "General",
"valueString": "Official Corporate Logo"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.title"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.creation",
"requirements": "This is often tracked as an integrity issue for use of the attachment.",
"min": 0,
"definition": "The date that the attachment was first created.",
"short": "Date attachment was first created",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.creation",
"comment": "UTC offset is allowed for dates and partial dates",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.creation"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.height",
"min": 0,
"definition": "Height of the image in pixels (photo/video).",
"short": "Height of the image in pixels (photo/video)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.height",
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.height"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.width",
"min": 0,
"definition": "Width of the image in pixels (photo/video).",
"short": "Width of the image in pixels (photo/video)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.width",
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.width"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.frames",
"min": 0,
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"short": "Number of frames if > 1 (photo)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.frames",
"comment": "if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.frames"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.duration",
"min": 0,
"definition": "The duration of the recording in seconds - for audio and video.",
"short": "Length in seconds (audio / video)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.duration",
"comment": "The duration might differ from occurrencePeriod if recording was paused.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.duration"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.attachment.pages",
"min": 0,
"definition": "The number of pages when printed.",
"short": "Number of printed pages",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "0",
"id": "DocumentReference.content:original.attachment.pages",
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.pages"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile",
"min": 1,
"definition": "An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.",
"isModifier": false,
"short": "Content profile rules for the document",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.meta.profile",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.formatCode",
"identity": "xds"
}, {
"map": "derived from the IHE Profile or Implementation Guide templateID",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "format", "formatCode" ],
"max": "1",
"id": "DocumentReference.content:original.profile",
"comment": "Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.\n\nFor FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.content.profile"
},
"isSummary": true
}, {
"path": "DocumentReference.content.profile.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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:original.profile.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:original.profile.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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.content:original.profile.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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x]",
"min": 1,
"definition": "Code|uri|canonical.",
"isModifier": false,
"short": "Code|uri|canonical",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Composition.meta.profile",
"identity": "fhircomposition"
}, {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.formatCode",
"identity": "xds"
}, {
"map": "derived from the IHE Profile or Implementation Guide templateID",
"identity": "cda"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentFormat"
} ],
"description": "Document Format Codes."
},
"max": "1",
"id": "DocumentReference.content:original.profile.value[x]",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.content.profile.value[x]"
},
"isSummary": true
}, {
"path": "DocumentReference.content.profile.value[x].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.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content:original.profile.value[x].id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DocumentReference.content.profile.value[x].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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.content:original.profile.value[x].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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].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.",
"short": "Identity of the terminology system",
"fixedUri": "https://api.ndp.scot/storage/digital-dermatology/CodeSystem/image-size",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "DocumentReference.content:original.profile.value[x].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 be an absolute reference to some definition that establishes the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"id": "DocumentReference.content:original.profile.value[x].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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].code",
"fixedCode": "original",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "DocumentReference.content:original.profile.value[x].code",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "DocumentReference.content:original.profile.value[x].display",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DocumentReference.content.profile.value[x].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).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"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"
} ],
"max": "0",
"id": "DocumentReference.content:original.profile.value[x].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
} ]
},
"status": "active",
"id": "db86aff1-36f9-4c20-a604-8a012c7ff285",
"kind": "resource",
"url": "https://api.ndp.scot/storage/digital-dermatology/StructureDefinition/DocumentReference",
"version": null,
"differential": {
"element": [ {
"id": "DocumentReference.text",
"max": "0",
"path": "DocumentReference.text"
}, {
"id": "DocumentReference.identifier",
"min": 1,
"path": "DocumentReference.identifier"
}, {
"id": "DocumentReference.basedOn",
"max": "0",
"path": "DocumentReference.basedOn"
}, {
"id": "DocumentReference.status",
"path": "DocumentReference.status",
"fixedCode": "current"
}, {
"id": "DocumentReference.docStatus",
"min": 1,
"path": "DocumentReference.docStatus"
}, {
"id": "DocumentReference.modality",
"max": "0",
"path": "DocumentReference.modality"
}, {
"id": "DocumentReference.type",
"min": 1,
"path": "DocumentReference.type"
}, {
"id": "DocumentReference.type.coding",
"max": "1",
"min": 1,
"path": "DocumentReference.type.coding"
}, {
"id": "DocumentReference.type.coding.system",
"min": 1,
"path": "DocumentReference.type.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "DocumentReference.type.coding.version",
"max": "0",
"path": "DocumentReference.type.coding.version"
}, {
"id": "DocumentReference.type.coding.code",
"min": 1,
"path": "DocumentReference.type.coding.code",
"fixedCode": "820091000000101"
}, {
"id": "DocumentReference.type.coding.userSelected",
"max": "0",
"path": "DocumentReference.type.coding.userSelected"
}, {
"id": "DocumentReference.type.text",
"max": "0",
"path": "DocumentReference.type.text"
}, {
"id": "DocumentReference.category",
"max": "1",
"min": 1,
"path": "DocumentReference.category"
}, {
"id": "DocumentReference.category.coding",
"max": "1",
"min": 1,
"path": "DocumentReference.category.coding"
}, {
"id": "DocumentReference.category.coding.system",
"min": 1,
"path": "DocumentReference.category.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "DocumentReference.category.coding.version",
"max": "0",
"path": "DocumentReference.category.coding.version"
}, {
"id": "DocumentReference.category.coding.code",
"min": 1,
"path": "DocumentReference.category.coding.code",
"fixedCode": "820241000000102"
}, {
"id": "DocumentReference.category.coding.userSelected",
"max": "0",
"path": "DocumentReference.category.coding.userSelected"
}, {
"id": "DocumentReference.category.text",
"max": "0",
"path": "DocumentReference.category.text"
}, {
"id": "DocumentReference.subject",
"min": 1,
"path": "DocumentReference.subject"
}, {
"id": "DocumentReference.subject.reference",
"min": 1,
"path": "DocumentReference.subject.reference"
}, {
"id": "DocumentReference.subject.type",
"min": 1,
"path": "DocumentReference.subject.type",
"fixedUri": "Patient"
}, {
"id": "DocumentReference.subject.identifier",
"max": "0",
"path": "DocumentReference.subject.identifier"
}, {
"id": "DocumentReference.subject.display",
"max": "0",
"path": "DocumentReference.subject.display"
}, {
"id": "DocumentReference.context",
"max": "1",
"min": 1,
"path": "DocumentReference.context"
}, {
"id": "DocumentReference.context.reference",
"min": 1,
"path": "DocumentReference.context.reference"
}, {
"id": "DocumentReference.context.type",
"min": 1,
"path": "DocumentReference.context.type",
"fixedUri": "Encounter"
}, {
"id": "DocumentReference.context.identifier",
"max": "0",
"path": "DocumentReference.context.identifier"
}, {
"id": "DocumentReference.context.display",
"max": "0",
"path": "DocumentReference.context.display"
}, {
"id": "DocumentReference.event",
"max": "0",
"path": "DocumentReference.event"
}, {
"id": "DocumentReference.bodySite",
"max": "0",
"path": "DocumentReference.bodySite"
}, {
"id": "DocumentReference.facilityType",
"max": "0",
"path": "DocumentReference.facilityType"
}, {
"id": "DocumentReference.practiceSetting",
"max": "0",
"path": "DocumentReference.practiceSetting"
}, {
"id": "DocumentReference.period",
"max": "0",
"path": "DocumentReference.period"
}, {
"id": "DocumentReference.date",
"min": 1,
"path": "DocumentReference.date"
}, {
"id": "DocumentReference.author",
"max": "1",
"min": 1,
"path": "DocumentReference.author"
}, {
"id": "DocumentReference.author.reference",
"min": 1,
"path": "DocumentReference.author.reference"
}, {
"id": "DocumentReference.author.type",
"min": 1,
"path": "DocumentReference.author.type"
}, {
"id": "DocumentReference.author.identifier",
"max": "0",
"path": "DocumentReference.author.identifier"
}, {
"id": "DocumentReference.author.display",
"max": "0",
"path": "DocumentReference.author.display"
}, {
"id": "DocumentReference.attester",
"max": "0",
"path": "DocumentReference.attester"
}, {
"id": "DocumentReference.custodian",
"max": "0",
"path": "DocumentReference.custodian"
}, {
"id": "DocumentReference.relatesTo",
"max": "0",
"path": "DocumentReference.relatesTo"
}, {
"id": "DocumentReference.description",
"max": "0",
"path": "DocumentReference.description"
}, {
"id": "DocumentReference.securityLabel",
"max": "0",
"path": "DocumentReference.securityLabel"
}, {
"id": "DocumentReference.content",
"max": "3",
"min": 3,
"path": "DocumentReference.content",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "profile.value.code",
"type": "value"
} ]
}
}, {
"id": "DocumentReference.content:thumbnail",
"max": "1",
"min": 1,
"path": "DocumentReference.content",
"sliceName": "thumbnail"
}, {
"id": "DocumentReference.content:thumbnail.attachment.contentType",
"min": 1,
"path": "DocumentReference.content.attachment.contentType",
"fixedCode": "image/jpeg"
}, {
"id": "DocumentReference.content:thumbnail.attachment.language",
"max": "0",
"path": "DocumentReference.content.attachment.language"
}, {
"id": "DocumentReference.content:thumbnail.attachment.data",
"max": "0",
"path": "DocumentReference.content.attachment.data"
}, {
"id": "DocumentReference.content:thumbnail.attachment.url",
"max": "0",
"path": "DocumentReference.content.attachment.url"
}, {
"id": "DocumentReference.content:thumbnail.attachment.size",
"max": "0",
"path": "DocumentReference.content.attachment.size"
}, {
"id": "DocumentReference.content:thumbnail.attachment.hash",
"max": "0",
"path": "DocumentReference.content.attachment.hash"
}, {
"id": "DocumentReference.content:thumbnail.attachment.title",
"max": "0",
"path": "DocumentReference.content.attachment.title"
}, {
"id": "DocumentReference.content:thumbnail.attachment.creation",
"max": "0",
"path": "DocumentReference.content.attachment.creation"
}, {
"id": "DocumentReference.content:thumbnail.attachment.height",
"max": "0",
"path": "DocumentReference.content.attachment.height"
}, {
"id": "DocumentReference.content:thumbnail.attachment.width",
"max": "0",
"path": "DocumentReference.content.attachment.width"
}, {
"id": "DocumentReference.content:thumbnail.attachment.frames",
"max": "0",
"path": "DocumentReference.content.attachment.frames"
}, {
"id": "DocumentReference.content:thumbnail.attachment.duration",
"max": "0",
"path": "DocumentReference.content.attachment.duration"
}, {
"id": "DocumentReference.content:thumbnail.attachment.pages",
"max": "0",
"path": "DocumentReference.content.attachment.pages"
}, {
"id": "DocumentReference.content:thumbnail.profile",
"max": "1",
"min": 1,
"path": "DocumentReference.content.profile"
}, {
"id": "DocumentReference.content:thumbnail.profile.value[x]",
"path": "DocumentReference.content.profile.value[x]",
"type": [ {
"code": "Coding"
} ]
}, {
"id": "DocumentReference.content:thumbnail.profile.value[x].system",
"min": 1,
"path": "DocumentReference.content.profile.value[x].system",
"fixedUri": "https://api.ndp.scot/storage/digital-dermatology/CodeSystem/image-size"
}, {
"id": "DocumentReference.content:thumbnail.profile.value[x].version",
"max": "0",
"path": "DocumentReference.content.profile.value[x].version"
}, {
"id": "DocumentReference.content:thumbnail.profile.value[x].code",
"min": 1,
"path": "DocumentReference.content.profile.value[x].code",
"fixedCode": "thumbnail"
}, {
"id": "DocumentReference.content:thumbnail.profile.value[x].display",
"max": "0",
"path": "DocumentReference.content.profile.value[x].display"
}, {
"id": "DocumentReference.content:thumbnail.profile.value[x].userSelected",
"max": "0",
"path": "DocumentReference.content.profile.value[x].userSelected"
}, {
"id": "DocumentReference.content:high_resolution",
"max": "1",
"min": 1,
"path": "DocumentReference.content",
"sliceName": "high_resolution"
}, {
"id": "DocumentReference.content:high_resolution.attachment.contentType",
"min": 1,
"path": "DocumentReference.content.attachment.contentType",
"fixedCode": "image/jpeg"
}, {
"id": "DocumentReference.content:high_resolution.attachment.language",
"max": "0",
"path": "DocumentReference.content.attachment.language"
}, {
"id": "DocumentReference.content:high_resolution.attachment.data",
"max": "0",
"path": "DocumentReference.content.attachment.data"
}, {
"id": "DocumentReference.content:high_resolution.attachment.url",
"max": "0",
"path": "DocumentReference.content.attachment.url"
}, {
"id": "DocumentReference.content:high_resolution.attachment.size",
"max": "0",
"path": "DocumentReference.content.attachment.size"
}, {
"id": "DocumentReference.content:high_resolution.attachment.hash",
"max": "0",
"path": "DocumentReference.content.attachment.hash"
}, {
"id": "DocumentReference.content:high_resolution.attachment.title",
"max": "0",
"path": "DocumentReference.content.attachment.title"
}, {
"id": "DocumentReference.content:high_resolution.attachment.creation",
"max": "0",
"path": "DocumentReference.content.attachment.creation"
}, {
"id": "DocumentReference.content:high_resolution.attachment.height",
"max": "0",
"path": "DocumentReference.content.attachment.height"
}, {
"id": "DocumentReference.content:high_resolution.attachment.width",
"max": "0",
"path": "DocumentReference.content.attachment.width"
}, {
"id": "DocumentReference.content:high_resolution.attachment.frames",
"max": "0",
"path": "DocumentReference.content.attachment.frames"
}, {
"id": "DocumentReference.content:high_resolution.attachment.duration",
"max": "0",
"path": "DocumentReference.content.attachment.duration"
}, {
"id": "DocumentReference.content:high_resolution.attachment.pages",
"max": "0",
"path": "DocumentReference.content.attachment.pages"
}, {
"id": "DocumentReference.content:high_resolution.profile",
"max": "1",
"min": 1,
"path": "DocumentReference.content.profile"
}, {
"id": "DocumentReference.content:high_resolution.profile.value[x]",
"path": "DocumentReference.content.profile.value[x]",
"type": [ {
"code": "Coding"
} ]
}, {
"id": "DocumentReference.content:high_resolution.profile.value[x].system",
"min": 1,
"path": "DocumentReference.content.profile.value[x].system",
"fixedUri": "https://api.ndp.scot/storage/digital-dermatology/CodeSystem/image-size"
}, {
"id": "DocumentReference.content:high_resolution.profile.value[x].version",
"max": "0",
"path": "DocumentReference.content.profile.value[x].version"
}, {
"id": "DocumentReference.content:high_resolution.profile.value[x].code",
"min": 1,
"path": "DocumentReference.content.profile.value[x].code",
"fixedCode": "high_resolution"
}, {
"id": "DocumentReference.content:high_resolution.profile.value[x].display",
"max": "0",
"path": "DocumentReference.content.profile.value[x].display"
}, {
"id": "DocumentReference.content:high_resolution.profile.value[x].userSelected",
"max": "0",
"path": "DocumentReference.content.profile.value[x].userSelected"
}, {
"id": "DocumentReference.content:original",
"max": "1",
"min": 1,
"path": "DocumentReference.content",
"sliceName": "original"
}, {
"id": "DocumentReference.content:original.attachment.contentType",
"min": 1,
"path": "DocumentReference.content.attachment.contentType",
"fixedCode": "image/jpeg"
}, {
"id": "DocumentReference.content:original.attachment.language",
"max": "0",
"path": "DocumentReference.content.attachment.language"
}, {
"id": "DocumentReference.content:original.attachment.data",
"max": "0",
"path": "DocumentReference.content.attachment.data"
}, {
"id": "DocumentReference.content:original.attachment.url",
"max": "0",
"path": "DocumentReference.content.attachment.url"
}, {
"id": "DocumentReference.content:original.attachment.size",
"max": "0",
"path": "DocumentReference.content.attachment.size"
}, {
"id": "DocumentReference.content:original.attachment.hash",
"max": "0",
"path": "DocumentReference.content.attachment.hash"
}, {
"id": "DocumentReference.content:original.attachment.title",
"max": "0",
"path": "DocumentReference.content.attachment.title"
}, {
"id": "DocumentReference.content:original.attachment.creation",
"max": "0",
"path": "DocumentReference.content.attachment.creation"
}, {
"id": "DocumentReference.content:original.attachment.height",
"max": "0",
"path": "DocumentReference.content.attachment.height"
}, {
"id": "DocumentReference.content:original.attachment.width",
"max": "0",
"path": "DocumentReference.content.attachment.width"
}, {
"id": "DocumentReference.content:original.attachment.frames",
"max": "0",
"path": "DocumentReference.content.attachment.frames"
}, {
"id": "DocumentReference.content:original.attachment.duration",
"max": "0",
"path": "DocumentReference.content.attachment.duration"
}, {
"id": "DocumentReference.content:original.attachment.pages",
"max": "0",
"path": "DocumentReference.content.attachment.pages"
}, {
"id": "DocumentReference.content:original.profile",
"max": "1",
"min": 1,
"path": "DocumentReference.content.profile"
}, {
"id": "DocumentReference.content:original.profile.value[x]",
"path": "DocumentReference.content.profile.value[x]",
"type": [ {
"code": "Coding"
} ]
}, {
"id": "DocumentReference.content:original.profile.value[x].system",
"min": 1,
"path": "DocumentReference.content.profile.value[x].system",
"fixedUri": "https://api.ndp.scot/storage/digital-dermatology/CodeSystem/image-size"
}, {
"id": "DocumentReference.content:original.profile.value[x].version",
"max": "0",
"path": "DocumentReference.content.profile.value[x].version"
}, {
"id": "DocumentReference.content:original.profile.value[x].code",
"min": 1,
"path": "DocumentReference.content.profile.value[x].code",
"fixedCode": "original"
}, {
"id": "DocumentReference.content:original.profile.value[x].display",
"max": "0",
"path": "DocumentReference.content.profile.value[x].display"
}, {
"id": "DocumentReference.content:original.profile.value[x].userSelected",
"max": "0",
"path": "DocumentReference.content.profile.value[x].userSelected"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}