{
"description": null,
"_filename": "StructureDefinition-VRDR-Death-Certificate-Reference.json",
"package_name": "hl7.fhir.us.vrdr",
"date": "2019-03-27T07:24:20+11:00",
"derivation": "constraint",
"publisher": "Hi3 Solutions",
"fhirVersion": "3.0.1",
"name": "VRDR Death Certificate Reference",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://ihe.net/xds",
"name": "XDS metadata equivalent",
"identity": "xds"
} ],
"abstract": false,
"type": "DocumentReference",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "DocumentReference",
"min": 0,
"definition": "A reference to a document.",
"short": "A reference to a document",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]",
"identity": "rim"
}, {
"map": "infrastructure.documents",
"identity": "w5"
} ],
"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": "MAY contain zero or one [0..1] id (CONF:4393-388).",
"short": "id",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "DocumentReference.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "DocumentReference.meta",
"min": 0,
"definition": "MAY contain zero or one [0..1] meta (CONF:4393-387).",
"short": "meta",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "DocumentReference.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "DocumentReference.meta.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.meta.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "DocumentReference.meta.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.meta.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"
}
}, {
"path": "DocumentReference.meta.versionId",
"min": 0,
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"short": "Version specific identifier",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "DocumentReference.meta.versionId",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.versionId"
},
"isSummary": true
}, {
"path": "DocumentReference.meta.lastUpdated",
"min": 0,
"definition": "When the resource last changed - e.g. when the version changed.",
"short": "When the resource version last changed",
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "DocumentReference.meta.lastUpdated",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.lastUpdated"
},
"isSummary": true
}, {
"path": "DocumentReference.meta.profile",
"min": 1,
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Death-Certificate-Reference\"(CONF:4393-389).",
"short": "profile",
"type": [ {
"code": "uri"
} ],
"patternString": "http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Death-Certificate-Reference",
"max": "1",
"id": "DocumentReference.meta.profile",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.profile"
},
"isSummary": true
}, {
"path": "DocumentReference.meta.security",
"min": 0,
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"short": "Security Labels applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "DocumentReference.meta.security",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.security"
},
"isSummary": true
}, {
"path": "DocumentReference.meta.tag",
"min": 0,
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"short": "Tags applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
} ],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags"
}
},
"max": "*",
"id": "DocumentReference.meta.tag",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.tag"
},
"isSummary": true
}, {
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "DocumentReference.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"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"
}
}, {
"path": "DocumentReference.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "DocumentReference.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"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, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "DocumentReference.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "DocumentReference.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
}
}, {
"path": "DocumentReference.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
}
}, {
"path": "DocumentReference.masterIdentifier",
"requirements": "The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form \"oid^extension\", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).",
"min": 0,
"definition": "Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.",
"short": "Master Version Specific Identifier",
"mapping": [ {
"map": "TXA-12",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "DocumentEntry.uniqueId",
"identity": "xds"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "DocumentReference.masterIdentifier",
"comment": "CDA Document Id extension and root.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.masterIdentifier"
},
"isSummary": true
}, {
"path": "DocumentReference.identifier",
"min": 1,
"definition": "SHALL contain exactly one [1..1] identifier (CONF:4393-392).",
"short": "identifier",
"mapping": [ {
"map": "TXA-16?",
"identity": "v2"
}, {
"map": ".id / .setId",
"identity": "rim"
}, {
"map": "DocumentEntry.entryUUID",
"identity": "xds"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "DocumentReference.identifier",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.identifier"
},
"isSummary": true
}, {
"path": "DocumentReference.status",
"min": 1,
"definition": "SHALL contain exactly one [1..1] status, which SHALL be selected from ValueSet DocumentReferenceStatus http://hl7.org/fhir/ValueSet/DocumentReferenceStatus DYNAMIC (CONF:4393-394).",
"isModifier": true,
"short": "status",
"mapping": [ {
"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 status",
"identity": "xds"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/document-reference-status"
}
},
"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"
},
"isSummary": true
}, {
"path": "DocumentReference.docStatus",
"min": 0,
"definition": "The status of the underlying document.",
"short": "preliminary | final | appended | amended | entered-in-error",
"mapping": [ {
"map": "TXA-17",
"identity": "v2"
}, {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferredDocumentStatus"
} ],
"description": "Status of the underlying document.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/composition-status"
}
},
"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
}, {
"path": "DocumentReference.type",
"min": 1,
"definition": "SHALL contain exactly one [1..1] type=\"\"64297-5\"\"(CONF:4393-396).",
"short": "type",
"mapping": [ {
"map": "TXA-2",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "DocumentEntry.type",
"identity": "xds"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"fixedCodeableConcept": {
"coding": [ {
"code": "\"64297-5\""
} ]
},
"binding": {
"strength": "preferred",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80Type"
} ],
"description": "Precise type of clinical document.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes"
}
},
"max": "1",
"id": "DocumentReference.type",
"comment": "Key metadata element describing the document, used in searching/filtering.",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.type"
},
"isSummary": true
}, {
"path": "DocumentReference.class",
"requirements": "Helps humans to assess whether the document is of interest when viewing a list of documents.",
"min": 0,
"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.",
"short": "Categorization of document",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code",
"identity": "rim"
}, {
"map": "DocumentEntry.class",
"identity": "xds"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80Class"
} ],
"description": "High-level kind of a clinical document at a macro level.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-doc-classcodes"
}
},
"alias": [ "kind" ],
"max": "1",
"id": "DocumentReference.class",
"comment": "This is a metadata field from [XDS/MHD](http://wiki.ihe.net/index.php?title=Mobile_access_to_Health_Documents_(MHD)).",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.class"
},
"isSummary": true
}, {
"path": "DocumentReference.subject",
"min": 1,
"definition": "SHALL contain exactly one [1..1] subject=\"VRDR Decedent\"(CONF:4393-395).",
"short": "subject",
"mapping": [ {
"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": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
} ],
"patternString": "VRDR Decedent",
"max": "1",
"id": "DocumentReference.subject",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.subject"
},
"isSummary": true
}, {
"path": "DocumentReference.created",
"min": 0,
"definition": "When the document was created.",
"short": "Document creation time",
"mapping": [ {
"map": "TXA-6",
"identity": "v2"
}, {
"map": ".effectiveTime[type=\"TS\"]",
"identity": "rim"
}, {
"map": "DocumentEntry.submissionTime",
"identity": "xds"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "DocumentReference.created",
"comment": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document, not the source material on which it is based.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.created"
},
"isSummary": true
}, {
"path": "DocumentReference.indexed",
"min": 1,
"definition": "SHALL contain exactly one [1..1] indexed (CONF:4393-393).",
"short": "indexed",
"mapping": [ {
"map": ".availabilityTime[type=\"TS\"]",
"identity": "rim"
}, {
"map": "DocumentEntry.submissionTime",
"identity": "xds"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "DocumentReference.indexed",
"comment": "Referencing/indexing time is used for tracking, organizing versions and searching.",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.indexed"
},
"isSummary": true
}, {
"path": "DocumentReference.author",
"min": 1,
"definition": "SHALL contain exactly one [1..1] author=\"VRDR Interested Party\"(CONF:4393-390).",
"short": "author",
"mapping": [ {
"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": "who.author",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"patternString": "VRDR Interested Party",
"max": "1",
"id": "DocumentReference.author",
"comment": "Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant).",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.author"
},
"isSummary": true
}, {
"path": "DocumentReference.authenticator",
"min": 0,
"definition": "Which person or organization authenticates that this document is valid.",
"short": "Who/what authenticated the document",
"mapping": [ {
"map": "TXA-10",
"identity": "v2"
}, {
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]",
"identity": "rim"
}, {
"map": "DocumentEntry.legalAuthenticator",
"identity": "xds"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "DocumentReference.authenticator",
"comment": "Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.authenticator"
},
"isSummary": true
}, {
"path": "DocumentReference.custodian",
"min": 0,
"definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.",
"short": "Organization which maintains the document",
"mapping": [ {
"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"
} ],
"max": "1",
"id": "DocumentReference.custodian",
"comment": "Identifies the logical organization to go to find the current version, where to report issues, etc. This is different from the physical location 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": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "DocumentReference.relatesTo",
"min": 0,
"definition": "Relationships that this document has with other document references that already exist.",
"isModifier": true,
"short": "Relationships to other documents",
"mapping": [ {
"map": ".outboundRelationship",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.relatesTo.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
}
}, {
"path": "DocumentReference.relatesTo.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
},
"isSummary": true
}, {
"path": "DocumentReference.relatesTo.code",
"min": 1,
"definition": "The type of relationship that this document has with anther document.",
"short": "replaces | transforms | signs | appends",
"mapping": [ {
"map": ".outboundRelationship.typeCode",
"identity": "rim"
}, {
"map": "DocumentEntry Associations type",
"identity": "xds"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentRelationshipType"
} ],
"description": "The type of relationship between documents.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/document-relationship-type"
}
},
"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
}, {
"path": "DocumentReference.relatesTo.target",
"min": 1,
"definition": "The target document of this relationship.",
"short": "Target of the relationship",
"mapping": [ {
"map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id",
"identity": "rim"
}, {
"map": "DocumentEntry Associations reference",
"identity": "xds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
} ],
"max": "1",
"id": "DocumentReference.relatesTo.target",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.relatesTo.target"
},
"isSummary": true
}, {
"path": "DocumentReference.description",
"requirements": "Helps humans to assess whether the document is of interest.",
"min": 0,
"definition": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"short": "Human-readable description (title)",
"mapping": [ {
"map": "TXA-25",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text",
"identity": "rim"
}, {
"map": "DocumentEntry.description",
"identity": "xds"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "DocumentReference.description",
"comment": "What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a \"consultation\" or \"progress note\").",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.description"
},
"isSummary": true
}, {
"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. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.",
"short": "Document security-tags",
"mapping": [ {
"map": "TXA-18",
"identity": "v2"
}, {
"map": ".confidentialityCode",
"identity": "rim"
}, {
"map": "DocumentEntry.confidentialityCode",
"identity": "xds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"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. In 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",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "DocumentReference.content",
"min": 1,
"definition": "The document and format referenced. There may be multiple content element repetitions, each with a different format.",
"short": "Document referenced",
"mapping": [ {
"map": "document.text",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "DocumentReference.content",
"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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.content.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
}
}, {
"path": "DocumentReference.content.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
},
"isSummary": true
}, {
"path": "DocumentReference.content.attachment",
"min": 1,
"definition": "The document or URL of the document along with critical metadata to prove content has integrity.",
"short": "Where to access the document",
"mapping": [ {
"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",
"identity": "xds"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "1",
"id": "DocumentReference.content.attachment",
"base": {
"max": "1",
"min": 1,
"path": "DocumentReference.content.attachment"
},
"isSummary": true
}, {
"path": "DocumentReference.content.format",
"min": 0,
"definition": "An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.",
"short": "Format/content rules for the document",
"mapping": [ {
"map": "document.text",
"identity": "rim"
}, {
"map": "DocumentEntry.formatCode",
"identity": "xds"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "preferred",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentFormat"
} ],
"description": "Document Format Codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/formatcodes"
}
},
"max": "1",
"id": "DocumentReference.content.format",
"comment": "Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.content.format"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "DocumentReference.context",
"min": 1,
"definition": "SHALL contain exactly one [1..1] context=\" VRDR Death Certificate\" (CONF:4393-391).",
"short": "context",
"mapping": [ {
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"patternString": "VRDR Death Certificate",
"max": "1",
"id": "DocumentReference.context",
"comment": "These values are primarily added to help with searching for interesting/relevant documents.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.context"
},
"isSummary": true
}, {
"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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.context.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
}
}, {
"path": "DocumentReference.context.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.context.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"
},
"isSummary": true
}, {
"path": "DocumentReference.context.encounter",
"min": 0,
"definition": "Describes the clinical encounter or type of care that the document content is associated with.",
"short": "Context of the document content",
"mapping": [ {
"map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])",
"identity": "rim"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
} ],
"max": "1",
"id": "DocumentReference.context.encounter",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.context.encounter"
},
"isSummary": true
}, {
"path": "DocumentReference.context.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 typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"short": "Main clinical acts documented",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "DocumentEntry.eventCodeList",
"identity": "xds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentEventType"
} ],
"description": "This list of codes represents the main clinical acts being documented.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActCode"
}
},
"max": "*",
"id": "DocumentReference.context.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.context.event"
},
"isSummary": true
}, {
"path": "DocumentReference.context.period",
"min": 0,
"definition": "The time period over which the service that is described by the document was provided.",
"short": "Time of service that is being documented",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "DocumentEntry.serviceStartTime DocumentEntry.serviceStopTime",
"identity": "xds"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "DocumentReference.context.period",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.context.period"
},
"isSummary": true
}, {
"path": "DocumentReference.context.facilityType",
"min": 0,
"definition": "The kind of facility where the patient was seen.",
"short": "Kind of facility where patient was seen",
"mapping": [ {
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code",
"identity": "rim"
}, {
"map": "DocumentEntry.healthcareFacilityTypeCode",
"identity": "xds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80FacilityType"
} ],
"description": "XDS Facility Type.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-facilitycodes"
}
},
"max": "1",
"id": "DocumentReference.context.facilityType",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.context.facilityType"
},
"isSummary": true
}, {
"path": "DocumentReference.context.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.",
"short": "Additional details about where the content was created (e.g. clinical specialty)",
"mapping": [ {
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code",
"identity": "rim"
}, {
"map": "DocumentEntry.practiceSettingCode",
"identity": "xds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80PracticeSetting"
} ],
"description": "Additional details about where the content was created (e.g. clinical specialty).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes"
}
},
"max": "1",
"id": "DocumentReference.context.practiceSetting",
"comment": "The value set for this content has an example binding because it is a value set decided by community policy. Other examples exist for consideration: * HITSP created the table HITSP/C80 Table 2-148 Clinical Specialty Value Set (a value set based upon SNOMED CT which is referenced by Direct (XDR and XDM for Direct Messaging Specification, Version 1), as well as Nationwide Health Information Network (NHIN). Query for Documents, Web Service Interface Specification, V 3.0, 07/27/2011 * ELGA (Austria) (ELGA CDA Implementie-rungsleitfäden Registrierung von CDA Dokumenten für ELGA mit IHE Cross-Enterprise Document Sharing: XDS Metadaten (XDSDocumentEntry), [1.2.40.0.34.7.6.3] * XDS Connect-a-thon practiceSettingCode.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.context.practiceSetting"
},
"isSummary": true
}, {
"path": "DocumentReference.context.sourcePatientInfo",
"min": 0,
"definition": "The Patient Information as known when the document was published. May be a reference to a version specific, or contained.",
"short": "Patient demographics from source",
"mapping": [ {
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]",
"identity": "rim"
}, {
"map": "DocumentEntry.sourcePatientInfo DocumentEntry.sourcePatientId",
"identity": "xds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
} ],
"max": "1",
"id": "DocumentReference.context.sourcePatientInfo",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.context.sourcePatientInfo"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "DocumentReference.context.related",
"min": 0,
"definition": "Related identifiers or resources associated with the DocumentReference.",
"short": "Related identifiers or resources",
"mapping": [ {
"map": "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct]",
"identity": "rim"
}, {
"map": "DocumentEntry.referenceIdList",
"identity": "xds"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "DocumentReference.context.related",
"comment": "May be identifiers or resources that caused the DocumentReference or referenced Document to be created.",
"base": {
"max": "*",
"min": 0,
"path": "DocumentReference.context.related"
},
"isSummary": true
}, {
"path": "DocumentReference.context.related.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DocumentReference.context.related.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "DocumentReference.context.related.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DocumentReference.context.related.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"
}
}, {
"path": "DocumentReference.context.related.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DocumentReference.context.related.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"
},
"isSummary": true
}, {
"path": "DocumentReference.context.related.identifier",
"min": 0,
"definition": "Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.",
"short": "Identifier of related objects or events",
"mapping": [ {
"map": "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct] .id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "DocumentReference.context.related.identifier",
"comment": "Order numbers, accession numbers, XDW workflow numbers.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.context.related.identifier"
},
"isSummary": true
}, {
"path": "DocumentReference.context.related.ref",
"min": 0,
"definition": "Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.",
"short": "Related Resource",
"mapping": [ {
"map": "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct].text.reference",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "DocumentReference.context.related.ref",
"comment": "Order, ProcedureRequest, Procedure, EligibilityRequest, etc.",
"base": {
"max": "1",
"min": 0,
"path": "DocumentReference.context.related.ref"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "08d2b72b-d27f-4e2d-9a0b-17ed89c8227f",
"kind": "resource",
"url": "http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Death-Certificate-Reference",
"context": [ "DocumentReference" ],
"version": "0.1.0",
"differential": {
"element": [ {
"id": "DocumentReference",
"path": "DocumentReference"
}, {
"id": "DocumentReference.id",
"max": "1",
"min": 0,
"path": "DocumentReference.id",
"short": "id",
"definition": "MAY contain zero or one [0..1] id (CONF:4393-388)."
}, {
"id": "DocumentReference.meta",
"max": "1",
"min": 0,
"path": "DocumentReference.meta",
"short": "meta",
"definition": "MAY contain zero or one [0..1] meta (CONF:4393-387)."
}, {
"id": "DocumentReference.meta.profile",
"max": "1",
"min": 1,
"path": "DocumentReference.meta.profile",
"short": "profile",
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Death-Certificate-Reference\"(CONF:4393-389).",
"patternString": "http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Death-Certificate-Reference"
}, {
"id": "DocumentReference.identifier",
"max": "1",
"min": 1,
"path": "DocumentReference.identifier",
"short": "identifier",
"definition": "SHALL contain exactly one [1..1] identifier (CONF:4393-392)."
}, {
"id": "DocumentReference.status",
"max": "1",
"min": 1,
"path": "DocumentReference.status",
"type": [ {
"code": "code"
} ],
"short": "status",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/document-reference-status"
}
},
"definition": "SHALL contain exactly one [1..1] status, which SHALL be selected from ValueSet DocumentReferenceStatus http://hl7.org/fhir/ValueSet/DocumentReferenceStatus DYNAMIC (CONF:4393-394)."
}, {
"id": "DocumentReference.type",
"max": "1",
"min": 1,
"path": "DocumentReference.type",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "type",
"definition": "SHALL contain exactly one [1..1] type=\"\"64297-5\"\"(CONF:4393-396).",
"fixedCodeableConcept": {
"coding": [ {
"code": "\"64297-5\""
} ]
}
}, {
"id": "DocumentReference.subject",
"max": "1",
"min": 1,
"path": "DocumentReference.subject",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
} ],
"short": "subject",
"definition": "SHALL contain exactly one [1..1] subject=\"VRDR Decedent\"(CONF:4393-395).",
"patternString": "VRDR Decedent"
}, {
"id": "DocumentReference.indexed",
"max": "1",
"min": 1,
"path": "DocumentReference.indexed",
"short": "indexed",
"definition": "SHALL contain exactly one [1..1] indexed (CONF:4393-393)."
}, {
"id": "DocumentReference.author",
"max": "1",
"min": 1,
"path": "DocumentReference.author",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"short": "author",
"definition": "SHALL contain exactly one [1..1] author=\"VRDR Interested Party\"(CONF:4393-390).",
"patternString": "VRDR Interested Party"
}, {
"id": "DocumentReference.context",
"max": "1",
"min": 1,
"path": "DocumentReference.context",
"type": [ {
"code": "BackboneElement"
} ],
"short": "context",
"definition": "SHALL contain exactly one [1..1] context=\" VRDR Death Certificate\" (CONF:4393-391).",
"patternString": "VRDR Death Certificate"
} ]
},
"contact": [ {
"name": "AbdulMalik Shakir",
"telecom": [ {
"use": "work",
"value": "6266444491",
"system": "phone"
}, {
"use": "work",
"value": "abdulmalik.shakir@hi3solutions.com",
"system": "email"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}