R4 Draft for Comment
FoundationThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R4B R4 R3 R2
| Structured Documents Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
StructureDefinition for documentmanifest
{
"resourceType": "StructureDefinition",
"id": "DocumentManifest",
"meta": {
"lastUpdated": "2017-12-20T15:52:34.818+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "sd"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/DocumentManifest",
"name": "DocumentManifest",
"status": "draft",
"date": "2017-12-20T15:52:34+11:00",
"publisher": "Health Level Seven International (Structured Documents)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure/index.cfm"
}
]
}
],
"description": "A collection of documents compiled for a purpose together with metadata that applies to the collection.",
"fhirVersion": "3.2.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "xds",
"uri": "http://ihe.net/xds",
"name": "XDS metadata equivalent"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "DocumentManifest",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "DocumentManifest",
"path": "DocumentManifest",
"short": "A list that defines a set of documents",
"definition": "A collection of documents compiled for a purpose together with metadata that applies to the collection.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"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",
"expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "rim",
"map": "Act[classCode=FOLDER, moodCode=EVN]"
},
{
"identity": "w5",
"map": "infrastructure.documents"
}
]
},
{
"id": "DocumentManifest.id",
"path": "DocumentManifest.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "DocumentManifest.meta",
"path": "DocumentManifest.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "DocumentManifest.implicitRules",
"path": "DocumentManifest.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "DocumentManifest.language",
"path": "DocumentManifest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"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
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "DocumentManifest.text",
"path": "DocumentManifest.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "DocumentManifest.contained",
"path": "DocumentManifest.contained",
"short": "Contained, inline Resources",
"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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentManifest.extension",
"path": "DocumentManifest.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentManifest.modifierExtension",
"path": "DocumentManifest.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentManifest.masterIdentifier",
"path": "DocumentManifest.masterIdentifier",
"short": "Unique Identifier for the set of documents",
"definition": "A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": "id [need a list semantic to indicate order matters]"
},
{
"identity": "xds",
"map": "SubmissionSet.uniqueId"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "DocumentManifest.identifier",
"path": "DocumentManifest.identifier",
"short": "Other identifiers for the manifest",
"definition": "Other identifiers associated with the document manifest, including version independent identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
},
{
"identity": "rim",
"map": ".id / .setId"
},
{
"identity": "xds",
"map": "SubmissionSet.entryUUID"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "DocumentManifest.status",
"path": "DocumentManifest.status",
"short": "current | superseded | entered-in-error",
"definition": "The status of this document manifest.",
"comment": "This element is labeled as a modifier because the status contains the codes that mark the manifest as not currently valid.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentReferenceStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The status of the document reference.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/document-reference-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "xds",
"map": "SubmissionSet status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "DocumentManifest.type",
"path": "DocumentManifest.type",
"short": "Kind of document set",
"definition": "Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80Type"
}
],
"strength": "extensible",
"description": "Precise type of clinical document.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "xds",
"map": "SubmissionSet.contentTypeCode"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "DocumentManifest.subject",
"path": "DocumentManifest.subject",
"short": "The subject of the set of documents",
"definition": "Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "xds",
"map": "SubmissionSet.patientId"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "DocumentManifest.created",
"path": "DocumentManifest.created",
"short": "When this document manifest created",
"definition": "When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).",
"comment": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.done[x]"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "xds",
"map": "SubmissionSet.submissionTime"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "DocumentManifest.agent",
"path": "DocumentManifest.agent",
"short": "Agent involved",
"definition": "An actor taking an active role in the manifest.",
"comment": "Several agents may be associated with the manifest.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer"
},
{
"identity": "w5",
"map": "FiveWs.author"
},
{
"identity": "rim",
"map": ".participation"
},
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"id": "DocumentManifest.agent.id",
"path": "DocumentManifest.agent.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentManifest.agent.extension",
"path": "DocumentManifest.agent.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentManifest.agent.modifierExtension",
"path": "DocumentManifest.agent.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentManifest.agent.type",
"path": "DocumentManifest.agent.type",
"short": "How agent participated",
"definition": "Specification of the participation type the agent played.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AgentType"
}
],
"strength": "extensible",
"description": "The Participation type of the agent to the event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participation-role-type"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.function"
},
{
"identity": "rim",
"map": ".participation.typeCode"
}
]
},
{
"id": "DocumentManifest.agent.who",
"path": "DocumentManifest.agent.who",
"short": "Who and/or what had an agent participation",
"definition": "Identifies who is the agent. Such as the author of the manifest, and adding documents to it.",
"comment": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "xds",
"map": "SubmissionSet.author"
}
]
},
{
"id": "DocumentManifest.recipient",
"path": "DocumentManifest.recipient",
"short": "Intended to get notified about this set of documents",
"definition": "A patient, practitioner, or organization for which this set of documents is intended.",
"comment": "How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent. If the recipient is a person, and it is not known whether the person is a patient or a practitioner, RelatedPerson would be the default choice.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.performer"
},
{
"identity": "w5",
"map": "FiveWs.cause"
},
{
"identity": "rim",
"map": ".participation[typeCode=IRCP].role"
},
{
"identity": "xds",
"map": "SubmissionSet.intendedRecipient"
},
{
"identity": "w5",
"map": "who.cause"
}
]
},
{
"id": "DocumentManifest.source",
"path": "DocumentManifest.source",
"short": "The source system/application/software",
"definition": "Identifies the source system, application, or software that produced the document manifest.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].time"
},
{
"identity": "xds",
"map": "SubmissionSet.sourceId"
}
]
},
{
"id": "DocumentManifest.description",
"path": "DocumentManifest.description",
"short": "Human-readable description (title)",
"definition": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"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\").",
"requirements": "Helps humans to assess whether the document is of interest.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".title"
},
{
"identity": "xds",
"map": "SubmissionSet.title"
}
]
},
{
"id": "DocumentManifest.content",
"path": "DocumentManifest.content",
"short": "Items in manifest",
"definition": "The list of Resources that consist of the parts of this manifest.",
"comment": "When used for XDS the intended focus of the DocumentManifest is for the reference to target to be a set of DocumentReference Resources. The reference is to \"Any\" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources.",
"requirements": "Any Resources are allowed to be grouped in a Manifest. The manifest brings context to the group.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
},
{
"identity": "xds",
"map": "SubmissionSet DocumentEntry(s)"
}
]
},
{
"id": "DocumentManifest.related",
"path": "DocumentManifest.related",
"short": "Related things",
"definition": "Related identifiers or resources associated with the DocumentManifest.",
"comment": "May be identifiers or resources that caused the DocumentManifest to be created.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentManifest.related.id",
"path": "DocumentManifest.related.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentManifest.related.extension",
"path": "DocumentManifest.related.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentManifest.related.modifierExtension",
"path": "DocumentManifest.related.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentManifest.related.identifier",
"path": "DocumentManifest.related.identifier",
"short": "Identifiers of things that are related",
"definition": "Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.",
"comment": "If both identifier and ref elements are present they shall refer to the same thing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "DocumentManifest.related.ref",
"path": "DocumentManifest.related.ref",
"short": "Related Resource",
"definition": "Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.",
"comment": "If both identifier and ref elements are present they shall refer to the same thing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
}
]
},
"differential": {
"element": [
{
"id": "DocumentManifest",
"path": "DocumentManifest",
"short": "A list that defines a set of documents",
"definition": "A collection of documents compiled for a purpose together with metadata that applies to the collection.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "rim",
"map": "Act[classCode=FOLDER, moodCode=EVN]"
},
{
"identity": "w5",
"map": "infrastructure.documents"
}
]
},
{
"id": "DocumentManifest.masterIdentifier",
"path": "DocumentManifest.masterIdentifier",
"short": "Unique Identifier for the set of documents",
"definition": "A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": "id [need a list semantic to indicate order matters]"
},
{
"identity": "xds",
"map": "SubmissionSet.uniqueId"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "DocumentManifest.identifier",
"path": "DocumentManifest.identifier",
"short": "Other identifiers for the manifest",
"definition": "Other identifiers associated with the document manifest, including version independent identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
},
{
"identity": "rim",
"map": ".id / .setId"
},
{
"identity": "xds",
"map": "SubmissionSet.entryUUID"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "DocumentManifest.status",
"path": "DocumentManifest.status",
"short": "current | superseded | entered-in-error",
"definition": "The status of this document manifest.",
"comment": "This element is labeled as a modifier because the status contains the codes that mark the manifest as not currently valid.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentReferenceStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The status of the document reference.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/document-reference-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "xds",
"map": "SubmissionSet status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "DocumentManifest.type",
"path": "DocumentManifest.type",
"short": "Kind of document set",
"definition": "Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80Type"
}
],
"strength": "extensible",
"description": "Precise type of clinical document.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "xds",
"map": "SubmissionSet.contentTypeCode"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "DocumentManifest.subject",
"path": "DocumentManifest.subject",
"short": "The subject of the set of documents",
"definition": "Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "xds",
"map": "SubmissionSet.patientId"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "DocumentManifest.created",
"path": "DocumentManifest.created",
"short": "When this document manifest created",
"definition": "When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).",
"comment": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.done[x]"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "xds",
"map": "SubmissionSet.submissionTime"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "DocumentManifest.agent",
"path": "DocumentManifest.agent",
"short": "Agent involved",
"definition": "An actor taking an active role in the manifest.",
"comment": "Several agents may be associated with the manifest.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer"
},
{
"identity": "w5",
"map": "FiveWs.author"
},
{
"identity": "rim",
"map": ".participation"
},
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"id": "DocumentManifest.agent.type",
"path": "DocumentManifest.agent.type",
"short": "How agent participated",
"definition": "Specification of the participation type the agent played.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AgentType"
}
],
"strength": "extensible",
"description": "The Participation type of the agent to the event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participation-role-type"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.function"
},
{
"identity": "rim",
"map": ".participation.typeCode"
}
]
},
{
"id": "DocumentManifest.agent.who",
"path": "DocumentManifest.agent.who",
"short": "Who and/or what had an agent participation",
"definition": "Identifies who is the agent. Such as the author of the manifest, and adding documents to it.",
"comment": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "xds",
"map": "SubmissionSet.author"
}
]
},
{
"id": "DocumentManifest.recipient",
"path": "DocumentManifest.recipient",
"short": "Intended to get notified about this set of documents",
"definition": "A patient, practitioner, or organization for which this set of documents is intended.",
"comment": "How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent. If the recipient is a person, and it is not known whether the person is a patient or a practitioner, RelatedPerson would be the default choice.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.performer"
},
{
"identity": "w5",
"map": "FiveWs.cause"
},
{
"identity": "rim",
"map": ".participation[typeCode=IRCP].role"
},
{
"identity": "xds",
"map": "SubmissionSet.intendedRecipient"
},
{
"identity": "w5",
"map": "who.cause"
}
]
},
{
"id": "DocumentManifest.source",
"path": "DocumentManifest.source",
"short": "The source system/application/software",
"definition": "Identifies the source system, application, or software that produced the document manifest.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].time"
},
{
"identity": "xds",
"map": "SubmissionSet.sourceId"
}
]
},
{
"id": "DocumentManifest.description",
"path": "DocumentManifest.description",
"short": "Human-readable description (title)",
"definition": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"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\").",
"requirements": "Helps humans to assess whether the document is of interest.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".title"
},
{
"identity": "xds",
"map": "SubmissionSet.title"
}
]
},
{
"id": "DocumentManifest.content",
"path": "DocumentManifest.content",
"short": "Items in manifest",
"definition": "The list of Resources that consist of the parts of this manifest.",
"comment": "When used for XDS the intended focus of the DocumentManifest is for the reference to target to be a set of DocumentReference Resources. The reference is to \"Any\" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources.",
"requirements": "Any Resources are allowed to be grouped in a Manifest. The manifest brings context to the group.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
},
{
"identity": "xds",
"map": "SubmissionSet DocumentEntry(s)"
}
]
},
{
"id": "DocumentManifest.related",
"path": "DocumentManifest.related",
"short": "Related things",
"definition": "Related identifiers or resources associated with the DocumentManifest.",
"comment": "May be identifiers or resources that caused the DocumentManifest to be created.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentManifest.related.identifier",
"path": "DocumentManifest.related.identifier",
"short": "Identifiers of things that are related",
"definition": "Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.",
"comment": "If both identifier and ref elements are present they shall refer to the same thing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "DocumentManifest.related.ref",
"path": "DocumentManifest.related.ref",
"short": "Related Resource",
"definition": "Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.",
"comment": "If both identifier and ref elements are present they shall refer to the same thing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:57+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change