FHIR IG Statistics: StructureDefinition/2.16.840.1.113883.10.20.22.4.115
| Package | hl7.cda.us.ccdar2dot2 |
| Type | StructureDefinition |
| Id | 2.16.840.1.113883.10.20.22.4.115 |
| FHIR Version | R4 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda-2.2/StructureDefinition-2.16.840.1.113883.10.20.22.4.115.html |
| URL | http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.115 |
| Version | 2.2 |
| Status | active |
| Date | 2022-05-13T15:50:12+00:00 |
| Name | ExternalDocumentReference |
| Title | External Document Reference |
| Realm | us |
| Authority | hl7 |
| Description | Where it is necessary to reference an external clinical document, the External Document Reference template can be used to reference this external document. However, if the containing document is appending to or replacing another document in the same set, that relationship is set in the header, using ClinicalDocument/relatedDocument. |
| Type | ExternalDocument |
| Kind | resource |
Resources that use this resource
Resources that this resource uses
No resources found
Narrative
Note: links and images are rebased to the (stated) source
Source
{
"resourceType": "StructureDefinition",
"id": "2.16.840.1.113883.10.20.22.4.115",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.115",
"identifier": [
{
"value": "urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09"
}
],
"version": "2.2",
"name": "ExternalDocumentReference",
"title": "External Document Reference",
"status": "active",
"date": "2022-05-13T15:50:12+00:00",
"publisher": "Health Level Seven",
"contact": [
{
"name": "HL7 International - Structured Documents",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description": "Where it is necessary to reference an external clinical document, the External Document Reference template can be used to reference this external document. However, if the containing document is appending to or replacing another document in the same set, that relationship is set in the header, using ClinicalDocument/relatedDocument.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "ExternalDocument",
"baseDefinition": "http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "ExternalDocument",
"path": "ExternalDocument",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "ExternalDocument.classCode",
"path": "ExternalDocument.classCode",
"representation": [
"xmlAttr"
],
"requirements": "SHALL contain exactly one [1..1] @classCode=\"DOCCLIN\" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931).",
"min": 1,
"max": "1",
"base": {
"path": "ExternalDocument.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "DOC",
"patternCode": "DOCCLIN",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClassDocument"
}
},
{
"id": "ExternalDocument.moodCode",
"path": "ExternalDocument.moodCode",
"representation": [
"xmlAttr"
],
"requirements": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932).",
"min": 1,
"max": "1",
"base": {
"path": "ExternalDocument.moodCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "EVN",
"fixedCode": "EVN",
"patternCode": "EVN",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActMood"
}
},
{
"id": "ExternalDocument.templateId",
"path": "ExternalDocument.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
},
{
"type": "value",
"path": "extension"
}
],
"rules": "open"
},
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "ExternalDocument.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "ExternalDocument.templateId:primary",
"path": "ExternalDocument.templateId",
"sliceName": "primary",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"requirements": "SHALL contain exactly one [1..1] templateId (CONF:1098-32748) such that it",
"min": 1,
"max": "1",
"base": {
"path": "ExternalDocument.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "ExternalDocument.templateId:primary.nullFlavor",
"path": "ExternalDocument.templateId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id": "ExternalDocument.templateId:primary.assigningAuthorityName",
"path": "ExternalDocument.templateId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ExternalDocument.templateId:primary.displayable",
"path": "ExternalDocument.templateId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "ExternalDocument.templateId:primary.root",
"path": "ExternalDocument.templateId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.4.115\" (CONF:1098-32750).",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"patternString": "2.16.840.1.113883.10.20.22.4.115"
},
{
"id": "ExternalDocument.templateId:primary.extension",
"path": "ExternalDocument.templateId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"requirements": "SHALL contain exactly one [1..1] @extension=\"2014-06-09\" (CONF:1098-32749).",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"patternString": "2014-06-09"
},
{
"id": "ExternalDocument.id",
"path": "ExternalDocument.id",
"requirements": "SHALL contain exactly one [1..1] id (CONF:1098-32751).",
"min": 1,
"max": "1",
"base": {
"path": "ExternalDocument.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "ExternalDocument.code",
"path": "ExternalDocument.code",
"requirements": "SHALL contain exactly one [1..1] code (CONF:1098-31933).",
"min": 1,
"max": "1",
"base": {
"path": "ExternalDocument.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-DocumentType"
}
},
{
"id": "ExternalDocument.text",
"path": "ExternalDocument.text",
"min": 0,
"max": "1",
"base": {
"path": "ExternalDocument.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id": "ExternalDocument.setId",
"path": "ExternalDocument.setId",
"requirements": "SHOULD contain zero or one [0..1] setId (CONF:1098-32752).",
"min": 0,
"max": "1",
"base": {
"path": "ExternalDocument.setId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "ExternalDocument.versionNumber",
"path": "ExternalDocument.versionNumber",
"requirements": "SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753).",
"min": 0,
"max": "1",
"base": {
"path": "ExternalDocument.versionNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/INT"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ExternalDocument",
"path": "ExternalDocument"
},
{
"id": "ExternalDocument.classCode",
"path": "ExternalDocument.classCode",
"requirements": "SHALL contain exactly one [1..1] @classCode=\"DOCCLIN\" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931).",
"min": 1,
"max": "1",
"patternCode": "DOCCLIN"
},
{
"id": "ExternalDocument.moodCode",
"path": "ExternalDocument.moodCode",
"requirements": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932).",
"min": 1,
"max": "1",
"patternCode": "EVN"
},
{
"id": "ExternalDocument.templateId",
"path": "ExternalDocument.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
},
{
"type": "value",
"path": "extension"
}
],
"rules": "open"
}
},
{
"id": "ExternalDocument.templateId:primary",
"path": "ExternalDocument.templateId",
"sliceName": "primary",
"requirements": "SHALL contain exactly one [1..1] templateId (CONF:1098-32748) such that it",
"min": 1,
"max": "1"
},
{
"id": "ExternalDocument.templateId:primary.root",
"path": "ExternalDocument.templateId.root",
"requirements": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.4.115\" (CONF:1098-32750).",
"min": 1,
"max": "1",
"patternString": "2.16.840.1.113883.10.20.22.4.115"
},
{
"id": "ExternalDocument.templateId:primary.extension",
"path": "ExternalDocument.templateId.extension",
"requirements": "SHALL contain exactly one [1..1] @extension=\"2014-06-09\" (CONF:1098-32749).",
"min": 1,
"max": "1",
"patternString": "2014-06-09"
},
{
"id": "ExternalDocument.id",
"path": "ExternalDocument.id",
"requirements": "SHALL contain exactly one [1..1] id (CONF:1098-32751).",
"min": 1,
"max": "1"
},
{
"id": "ExternalDocument.code",
"path": "ExternalDocument.code",
"requirements": "SHALL contain exactly one [1..1] code (CONF:1098-31933).",
"min": 1,
"max": "1"
},
{
"id": "ExternalDocument.setId",
"path": "ExternalDocument.setId",
"requirements": "SHOULD contain zero or one [0..1] setId (CONF:1098-32752).",
"min": 0,
"max": "1"
},
{
"id": "ExternalDocument.versionNumber",
"path": "ExternalDocument.versionNumber",
"requirements": "SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753).",
"min": 0,
"max": "1"
}
]
}
}
ExternalDocument 
Slices for templateId 
templateId:primary 
extension 
FHIR