{ "resourceType": "StructureDefinition", "id": "DocumentManifest", "meta": { "lastUpdated": "2018-11-22T17:33:35.809+00:00" }, "text": { "status": "generated", "div": "
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"DocumentManifestΣDomainResourceA list that defines a set of documents\n
Elements defined in Ancestors: \n id, \n meta, \n implicitRules, \n language, \n text, \n contained, \n extension, \n modifierExtension
\".\"\".\"\".\"masterIdentifierΣ0..1IdentifierUnique Identifier for the set of documents
\".\"\".\"\".\"identifierΣ0..*IdentifierOther identifiers for the manifest\n
\".\"\".\"\".\"status?!Σ1..1codecurrent | superseded | entered-in-error\n
DocumentReferenceStatus (\n Required)\n
\".\"\".\"\".\"typeΣ0..1CodeableConceptKind of document set\n
Document Type Value Set (\n Preferred)\n
\".\"\".\"\".\"subjectΣ0..1Reference(\n Patient | \n Practitioner | \n Group | \n Device)\n The subject of the set of documents
\".\"\".\"\".\"createdΣ0..1dateTimeWhen this document manifest created
\".\"\".\"\".\"authorΣ0..*Reference(\n Practitioner | \n Organization | \n Device | \n Patient | \n RelatedPerson)\n Who and/or what authored the manifest\n
\".\"\".\"\".\"recipientΣ0..*Reference(\n Patient | \n Practitioner | \n RelatedPerson | \n Organization)\n Intended to get notified about this set of documents\n
\".\"\".\"\".\"sourceΣ0..1uriThe source system/application/software
\".\"\".\"\".\"descriptionΣ0..1stringHuman-readable description (title)
\".\"\".\"\".\"contentΣ1..*BackboneElementThe items included\n
\".\"\".\"\".\"\".\"p[x]Σ1..1Contents of this set of documents
\".\"\".\"\".\"\".\"\".\"pAttachmentAttachment
\".\"\".\"\".\"\".\"\".\" pReference\n Reference(\n Any)\n
\".\"\".\"\".\"relatedΣ0..*BackboneElementRelated things\n
\".\"\".\"\".\"\".\"identifierΣ0..1IdentifierIdentifiers of things that are related
\".\"\".\"\".\"\".\"refΣ0..1Reference(\n Any)\n Related Resource

\"doco\" Documentation for this format\n
" }, "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": "2018-11-22T17:33:32.9540379+00: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": "Base StructureDefinition for DocumentManifest Resource", "fhirVersion": "3.0.1", "mapping": [ { "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", "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.", "mapping": [ { "identity": "rim", "map": "Act[classCode=FOLDER, moodCode=EVN]" }, { "identity": "w5", "map": "infrastructure.documents" } ] }, { "id": "DocumentManifest.Identifier", "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.", "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "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.", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "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.code", "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": "rim", "map": ".statusCode" }, { "identity": "xds", "map": "SubmissionSet status" }, { "identity": "w5", "map": "status" } ] }, { "id": "DocumentManifest.CodeableConcept", "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.", "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80Type" } ], "strength": "preferred", "description": "Precise type of clinical document.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "xds", "map": "SubmissionSet.contentTypeCode" }, { "identity": "w5", "map": "class" } ] }, { "id": "DocumentManifest.Reference", "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).", "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": "rim", "map": ".participation[typeCode=SBJ].role" }, { "identity": "xds", "map": "SubmissionSet.patientId" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "DocumentManifest.dateTime", "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.", "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "xds", "map": "SubmissionSet.submissionTime" }, { "identity": "w5", "map": "when.done" } ] }, { "id": "DocumentManifest.Reference", "path": "DocumentManifest.author", "short": "Who and/or what authored the manifest", "definition": "Identifies who is responsible for creating 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).", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "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": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "xds", "map": "SubmissionSet.author" }, { "identity": "w5", "map": "who.author" } ] }, { "id": "DocumentManifest.Reference", "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.", "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/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=IRCP].role" }, { "identity": "xds", "map": "SubmissionSet.intendedRecipient" }, { "identity": "w5", "map": "who.cause" } ] }, { "id": "DocumentManifest.uri", "path": "DocumentManifest.source", "short": "The source system/application/software", "definition": "Identifies the source system, application, or software that produced the document manifest.", "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=PFM].time" }, { "identity": "xds", "map": "SubmissionSet.sourceId" } ] }, { "id": "DocumentManifest.string", "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.", "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".title" }, { "identity": "xds", "map": "SubmissionSet.title" } ] }, { "id": "DocumentManifest.BackboneElement", "path": "DocumentManifest.content", "short": "The items included", "definition": "The list of Documents included in the manifest.", "min": 1, "type": [ { "code": "BackboneElement" } ], "isSummary": true }, { "id": "DocumentManifest.BackboneElement.Attachment", "path": "DocumentManifest.content.p[x]", "short": "Contents of this set of documents", "definition": "The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed.", "comment": "The intended focus of the DocumentManifest is for the reference to target either DocumentReference or Media Resources, and most implementation guides will restrict to these resources. The reference is to \"Any\" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources.", "min": 1, "max": "1", "type": [ { "code": "Attachment" }, { "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.BackboneElement", "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.", "type": [ { "code": "BackboneElement" } ], "isSummary": true }, { "id": "DocumentManifest.BackboneElement.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.", "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true }, { "id": "DocumentManifest.BackboneElement.Reference", "path": "DocumentManifest.related.ref", "short": "Related Resource", "definition": "Related Resource to this DocumentManifest. For example, Order, ProcedureRequest, Procedure, EligibilityRequest, etc.", "comment": "If both identifier and ref elements are present they shall refer to the same thing.", "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true } ] } }