. Page versions: R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 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
Profile for documentmanifest
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A manifest that defines a set of documents.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest\"><b>DocumentManifest</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.masterIdentifier\"><b>masterIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique Identifier for the set of documents</span><span style=\"color: Gray\"> --></span></masterIdentifier>\r\n <<a title=\"Other identifiers associated with the document, including version independent, source record and workflow related identifiers.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Other identifiers for the manifest</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"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).\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n The subject of the set of documents</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"A patient, practitioner, or organization for which this set of documents is intended.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.recipient\"><b>recipient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Intended to get notified about this set of documents</span><span style=\"color: Gray\"> --></span></recipient>\r\n <<a title=\"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.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-docset-codes.html\">What kind of document set this is</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Identifies who is responsible for adding the information to the document.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Who and/or what authored the document</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"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).\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.created\"><b>created</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When this document manifest created</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the source system, application, or software that produced the document manifest.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.source\"><b>source</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The source system/application/software</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of this document manifest (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-reference-status.html\">current | superceded | entered in error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether this document manifest replaces another (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.supercedes\"><span style=\"text-decoration: underline\"><b>supercedes</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"documentmanifest.html#DocumentManifest\">DocumentManifest</a>)</span> <span style=\"color: navy\">\r\n If this document manifest replaces another</span><span style=\"color: Gray\"> --></span></supercedes>\r\n <<a title=\"Human-readable description of the source document. This is sometimes known as the "title".\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human-readable description (title)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code specifying the level of confidentiality of this set of Documents (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/Confidentiality/index.html\">Sensitivity of set of documents</a><span style=\"color: Gray\"> --></span></confidentiality>\r\n <<a title=\"The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.content\"><b>content</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"documentreference.html#DocumentReference\">DocumentReference</a>|<a href=\"extras.html#Binary\">Binary</a>|<a href=\"media.html#Media\">Media</a>)</span> <span style=\"color: navy\">\r\n Contents of this set of documents</span><span style=\"color: Gray\"> --></span></content>\r\n</DocumentManifest>\r\n</pre></div>"
},
"name": "documentmanifest",
"publisher": "FHIR Project",
"description": "Basic Profile. A manifest that defines a set of documents.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A document manifest gathers a set of Document Reference resources into a single package that may be the subject of workflow such as access control, auditing, and targeted delivery. \r\n\r\nTypically, Document Manifest Resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile).",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "DocumentManifest",
"publish": true,
"element": [
{
"path": "DocumentManifest",
"definition": {
"short": "A manifest that defines a set of documents",
"formal": "A manifest that defines a set of documents.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=FOLDER, moodCode=EVN]"
}
]
}
},
{
"path": "DocumentManifest.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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.",
"comments": "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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentManifest.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentManifest.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "DocumentManifest.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"comments": "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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "DocumentManifest.masterIdentifier",
"definition": {
"short": "Unique Identifier for the set of documents",
"formal": "A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id [need a list semantic to indicate order matters]"
}
]
}
},
{
"path": "DocumentManifest.identifier",
"definition": {
"short": "Other identifiers for the manifest",
"formal": "Other identifiers associated with the document, including version independent, source record and workflow related identifiers.",
"comments": "Other identifiers can also include Identifiers may be Accession Numbers, Order Numbers, Referral Request \nIdentifiers, XDS Workflow Instance Identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id / .setId"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
}
]
}
},
{
"path": "DocumentManifest.subject",
"definition": {
"short": "The subject of the set of documents",
"formal": "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": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
}
},
{
"path": "DocumentManifest.recipient",
"definition": {
"short": "Intended to get notified about this set of documents",
"formal": "A patient, practitioner, or organization for which this set of documents is intended.",
"comments": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=IRCP].role"
}
]
}
},
{
"path": "DocumentManifest.type",
"definition": {
"short": "What kind of document set this is",
"formal": "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"
}
],
"isModifier": false,
"binding": {
"name": "DocumentSetType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/docset-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "DocumentManifest.author",
"definition": {
"short": "Who and/or what authored the document",
"formal": "Identifies who is responsible for adding the information to the document.",
"comments": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
}
},
{
"path": "DocumentManifest.created",
"definition": {
"short": "When this document manifest created",
"formal": "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).",
"comments": "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"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
}
},
{
"path": "DocumentManifest.source",
"definition": {
"short": "The source system/application/software",
"formal": "Identifies the source system, application, or software that produced the document manifest.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].time"
}
]
}
},
{
"path": "DocumentManifest.status",
"definition": {
"short": "current | superceded | entered in error",
"formal": "The status of this document manifest.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DocumentReferenceStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/document-reference-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
}
]
}
},
{
"path": "DocumentManifest.supercedes",
"definition": {
"short": "If this document manifest replaces another",
"formal": "Whether this document manifest replaces another.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DocumentManifest"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RPLC].target"
}
]
}
},
{
"path": "DocumentManifest.description",
"definition": {
"short": "Human-readable description (title)",
"formal": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"comments": "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\").",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
}
},
{
"path": "DocumentManifest.confidentiality",
"definition": {
"short": "Sensitivity of set of documents",
"formal": "A code specifying the level of confidentiality of this set of Documents.",
"comments": "The document set is at least as confidential as the most confidential of the documents in it.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "DocumentConfidentiality",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/Confidentiality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".confidentialityCode"
}
]
}
},
{
"path": "DocumentManifest.content",
"definition": {
"short": "Contents of this set of documents",
"formal": "The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed.",
"min": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DocumentReference"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Binary"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Media"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "author",
"type": "reference",
"documentation": "Who and/or what authored the document",
"xpath": "f:DocumentManifest/f:author"
},
{
"name": "confidentiality",
"type": "token",
"documentation": "Sensitivity of set of documents",
"xpath": "f:DocumentManifest/f:confidentiality"
},
{
"name": "content",
"type": "reference",
"documentation": "Contents of this set of documents",
"xpath": "f:DocumentManifest/f:content"
},
{
"name": "created",
"type": "date",
"documentation": "When this document manifest created",
"xpath": "f:DocumentManifest/f:created"
},
{
"name": "description",
"type": "string",
"documentation": "Human-readable description (title)",
"xpath": "f:DocumentManifest/f:description"
},
{
"name": "identifier",
"type": "token",
"documentation": "Unique Identifier for the set of documents"
},
{
"name": "recipient",
"type": "reference",
"documentation": "Intended to get notified about this set of documents",
"xpath": "f:DocumentManifest/f:recipient"
},
{
"name": "status",
"type": "token",
"documentation": "current | superceded | entered in error",
"xpath": "f:DocumentManifest/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the set of documents",
"xpath": "f:DocumentManifest/f:subject"
},
{
"name": "supersedes",
"type": "reference",
"documentation": "If this document manifest replaces another",
"xpath": "f:DocumentManifest/f:supercedes"
},
{
"name": "type",
"type": "token",
"documentation": "What kind of document set this is",
"xpath": "f:DocumentManifest/f:type"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change