{
"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.",
"_filename": "StructureDefinition-ExternalDocumentReference.json",
"package_name": "hl7.cda.us.ccda",
"date": "2023-12-21T01:13:10+10:00",
"derivation": "constraint",
"publisher": "Health Level Seven",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "ExternalDocumentReference",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "External Document Reference",
"package_version": "3.0.0-ballot",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
} ]
}
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "externalDocument"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri": "cda"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "should-setId",
"human": "SHOULD contain setId",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ExternalDocumentReference",
"severity": "warning",
"expression": "setId.exists()"
}, {
"key": "should-versionNumber",
"human": "SHOULD contain versionNumber",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ExternalDocumentReference",
"severity": "warning",
"expression": "versionNumber.exists()"
} ],
"path": "ExternalDocument",
"min": 1,
"definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"max": "1",
"id": "ExternalDocument",
"base": {
"max": "*",
"min": 0,
"path": "Base"
}
}, {
"path": "ExternalDocument.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ExternalDocument.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ExternalDocument.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ExternalDocument.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ExternalDocument.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ExternalDocument.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ExternalDocument.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ExternalDocument.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ExternalDocument.typeId.assigningAuthorityName",
"min": 0,
"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.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ExternalDocument.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ExternalDocument.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ExternalDocument.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ExternalDocument.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ExternalDocument.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ExternalDocument.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ExternalDocument.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ExternalDocument.templateId",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ExternalDocument.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
}, {
"path": "extension",
"type": "value"
} ]
},
"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"
}, {
"id": "ExternalDocument.templateId:external-doc-ref",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ExternalDocument.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"sliceName": "external-doc-ref",
"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"
}, {
"path": "ExternalDocument.templateId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ExternalDocument.templateId:external-doc-ref.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ExternalDocument.templateId.assigningAuthorityName",
"min": 0,
"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.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ExternalDocument.templateId:external-doc-ref.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ExternalDocument.templateId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ExternalDocument.templateId:external-doc-ref.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ExternalDocument.templateId.root",
"min": 1,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"patternString": "2.16.840.1.113883.10.20.22.4.115",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ExternalDocument.templateId:external-doc-ref.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ExternalDocument.templateId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"patternString": "2014-06-09",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ExternalDocument.templateId:external-doc-ref.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"path": "ExternalDocument.classCode",
"fixedCode": "DOCCLIN",
"min": 1,
"defaultValueCode": "DOC",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClassDocument"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExternalDocument.classCode",
"comment": "SHALL contain exactly one [1..1] @classCode=\"DOCCLIN\" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931).",
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.classCode"
}
}, {
"path": "ExternalDocument.moodCode",
"fixedCode": "EVN",
"min": 1,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActMood"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExternalDocument.moodCode",
"comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932).",
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.moodCode"
}
}, {
"id": "ExternalDocument.id",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "ExternalDocument.id"
},
"path": "ExternalDocument.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "SHALL contain exactly one [1..1] id (CONF:1098-32751)."
}, {
"id": "ExternalDocument.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.code"
},
"path": "ExternalDocument.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/doc-typecodes"
},
"comment": "SHALL contain exactly one [1..1] code (CONF:1098-31933)."
}, {
"id": "ExternalDocument.text",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.text"
},
"path": "ExternalDocument.text",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ]
}, {
"id": "ExternalDocument.setId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.setId"
},
"path": "ExternalDocument.setId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "SHOULD contain zero or one [0..1] setId (CONF:1098-32752)."
}, {
"id": "ExternalDocument.versionNumber",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ExternalDocument.versionNumber"
},
"path": "ExternalDocument.versionNumber",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
} ],
"comment": "SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753)."
} ]
},
"status": "draft",
"id": "89a96097-8e0a-4145-a068-c53b52079bd9",
"kind": "logical",
"url": "http://hl7.org/cda/us/ccda/StructureDefinition/ExternalDocumentReference",
"identifier": [ {
"value": "urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09"
} ],
"version": "3.0.0-ballot",
"differential": {
"element": [ {
"id": "ExternalDocument",
"path": "ExternalDocument",
"constraint": [ {
"key": "should-setId",
"human": "SHOULD contain setId",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ExternalDocumentReference",
"severity": "warning",
"expression": "setId.exists()"
}, {
"key": "should-versionNumber",
"human": "SHOULD contain versionNumber",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ExternalDocumentReference",
"severity": "warning",
"expression": "versionNumber.exists()"
} ]
}, {
"id": "ExternalDocument.templateId",
"min": 1,
"path": "ExternalDocument.templateId",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
}, {
"path": "extension",
"type": "value"
} ]
}
}, {
"id": "ExternalDocument.templateId:external-doc-ref",
"max": "1",
"min": 1,
"path": "ExternalDocument.templateId",
"sliceName": "external-doc-ref"
}, {
"id": "ExternalDocument.templateId:external-doc-ref.root",
"min": 1,
"path": "ExternalDocument.templateId.root",
"patternString": "2.16.840.1.113883.10.20.22.4.115"
}, {
"id": "ExternalDocument.templateId:external-doc-ref.extension",
"min": 1,
"path": "ExternalDocument.templateId.extension",
"patternString": "2014-06-09"
}, {
"id": "ExternalDocument.classCode",
"min": 1,
"path": "ExternalDocument.classCode",
"comment": "SHALL contain exactly one [1..1] @classCode=\"DOCCLIN\" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931).",
"fixedCode": "DOCCLIN"
}, {
"id": "ExternalDocument.moodCode",
"min": 1,
"path": "ExternalDocument.moodCode",
"comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932)."
}, {
"id": "ExternalDocument.id",
"max": "1",
"min": 1,
"path": "ExternalDocument.id",
"comment": "SHALL contain exactly one [1..1] id (CONF:1098-32751)."
}, {
"id": "ExternalDocument.code",
"min": 1,
"path": "ExternalDocument.code",
"comment": "SHALL contain exactly one [1..1] code (CONF:1098-31933)."
}, {
"id": "ExternalDocument.setId",
"path": "ExternalDocument.setId",
"comment": "SHOULD contain zero or one [0..1] setId (CONF:1098-32752)."
}, {
"id": "ExternalDocument.versionNumber",
"path": "ExternalDocument.versionNumber",
"comment": "SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753)."
} ]
},
"contact": [ {
"name": "HL7 International - Structured Documents",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/structure",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument"
}