This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
StructureDefinition for SubmissionSet
{ "resourceType": "StructureDefinition", "id": "xdsdocumentmanifest", "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "url": "http://hl7.org/fhir/StructureDefinition/xdsdocumentmanifest", "name": "XDS profile for Document Reference", "status": "draft", "publisher": "HL7", "contact": [ { "telecom": [ { "system": "other", "value": "http://www.hl7.org" } ] } ], "date": "2012-06-24", "description": "SubmissionSet", "fhirVersion": "1.4.0", "kind": "resource", "abstract": false, "baseType": "DocumentManifest", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentManifest", "derivation": "constraint", "snapshot": { "element": [ { "path": "DocumentManifest", "name": "XDSDocumentManifest", "short": "SubmissionSet", "definition": "A manifest that defines a set of documents.", "min": 0, "max": "*", "base": { "path": "DocumentManifest", "min": 0, "max": "*" }, "type": [ { "code": "DocumentManifest" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Act[classCode=FOLDER, moodCode=EVN]" }, { "identity": "w5", "map": "infrastructure.documents" } ] }, { "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.", "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "isSummary": true }, { "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 may not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "*" }, "type": [ { "code": "Meta" } ], "isSummary": true }, { "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.", "comments": "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 as much as possible.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "*" }, "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "path": "DocumentManifest.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comments": "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": "*" }, "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "A human language.", "valueSetUri": "http://tools.ietf.org/html/bcp47" } }, { "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.", "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "*" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "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.", "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.", "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" } ] }, { "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.", "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 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" } ] }, { "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.", "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 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" } ] }, { "path": "DocumentManifest.masterIdentifier", "short": "SubmissionSet.uniqueId", "definition": "A globally unique identifier for the SubmissionSet assigned by the creating entity.", "min": 1, "max": "1", "base": { "path": "DocumentManifest.masterIdentifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "xds", "map": "SubmissionSet.uniqueId" }, { "identity": "rim", "map": "id [need a list semantic to indicate order matters]" }, { "identity": "w5", "map": "id" } ] }, { "path": "DocumentManifest.identifier", "short": "Other identifiers for the manifest", "definition": "Other identifiers associated with the document manifest, including version independent identifiers.", "min": 0, "max": "*", "base": { "path": "DocumentManifest.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "xds", "map": "SubmissionSet.entryUUID" }, { "identity": "v2", "map": "TXA-16-Unique Document File Name?" }, { "identity": "rim", "map": ".id / .setId" }, { "identity": "w5", "map": "id" } ] }, { "path": "DocumentManifest.subject", "short": "SubmissionSet.patientId", "definition": "the subject of care whose longitudinal record is being reflected in this SubmissionSet.", "min": 0, "max": "1", "base": { "path": "DocumentManifest.subject", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ], "isSummary": true, "mapping": [ { "identity": "xds", "map": "SubmissionSet.patientId" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role" }, { "identity": "w5", "map": "who.focus" } ] }, { "path": "DocumentManifest.recipient", "short": "SubmissionSet.intendedRecipient ", "definition": "The organization(s) or person(s) for whom the SubmissionSet 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. 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": "*", "base": { "path": "DocumentManifest.recipient", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "isSummary": true, "mapping": [ { "identity": "xds", "map": "SubmissionSet.intendedRecipient" }, { "identity": "rim", "map": ".participation[typeCode=IRCP].role" }, { "identity": "w5", "map": "who.cause" } ] }, { "path": "DocumentManifest.type", "short": "SubmissionSet.contentTypeCode", "definition": "The code specifying the type of clinical activity that resulted in placing the documents in this SubmissionSet.", "min": 0, "max": "1", "base": { "path": "DocumentManifest.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "preferred", "description": "Precise type of clinical document.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes" } }, "mapping": [ { "identity": "xds", "map": "SubmissionSet.contentTypeCode" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "class" } ] }, { "path": "DocumentManifest.author", "short": "SubmissionSet.author", "definition": "The humans and/or machines that authored the document in the SubmissionSet. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty.", "comments": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).", "min": 1, "max": "*", "base": { "path": "DocumentManifest.author", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] } ], "isSummary": true, "mapping": [ { "identity": "xds", "map": "SubmissionSet.author" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.author" } ] }, { "path": "DocumentManifest.created", "short": "SubmissionSet.submissionTime", "definition": "Point in time at the creating entity when the SubmissionSet was created.", "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", "base": { "path": "DocumentManifest.created", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "xds", "map": "SubmissionSet.submissionTime" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.done" } ] }, { "path": "DocumentManifest.source", "short": "SubmissionSet.sourceId", "definition": "OID identifying the instance of the creating entity that contributed the SubmissionSet.", "min": 0, "max": "1", "base": { "path": "DocumentManifest.source", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "xds", "map": "SubmissionSet.sourceId" }, { "identity": "rim", "map": ".participation[typeCode=PFM].time" } ] }, { "path": "DocumentManifest.status", "short": "SubmissionSet.availabilityStatus", "definition": "The lifecycle status of the SubmissionSet.", "min": 1, "max": "1", "base": { "path": "DocumentManifest.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "The status of the document reference.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/document-reference-status" } }, "mapping": [ { "identity": "xds", "map": "SubmissionSet status" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] }, { "path": "DocumentManifest.description", "short": "SubmissionSet.title", "definition": "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\").", "requirements": "Helps humans to assess whether the document is of interest.", "min": 0, "max": "1", "base": { "path": "DocumentManifest.description", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "xds", "map": "SubmissionSet.title" }, { "identity": "rim", "map": ".title" } ] }, { "path": "DocumentManifest.content", "short": "SubmissionSet.documentEntry", "definition": "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": "*", "base": { "path": "DocumentManifest.content", "min": 1, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "DocumentManifest.content.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "DocumentManifest.content.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.", "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 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" } ] }, { "path": "DocumentManifest.content.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.", "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 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" } ] }, { "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.", "comments": "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", "base": { "path": "DocumentManifest.content.p[x]", "min": 1, "max": "1" }, "type": [ { "code": "Attachment" }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "isSummary": true, "mapping": [ { "identity": "xds", "map": "SubmissionSet DocumentEntry(s)" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target" } ] }, { "path": "DocumentManifest.related", "short": "Related things", "definition": "Related identifiers or resources associated with the DocumentManifest.", "comments": "May be identifiers or resources that caused the DocumentManifest to be created.", "min": 0, "max": "*", "base": { "path": "DocumentManifest.related", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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).", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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.", "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 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" } ] }, { "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.", "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 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" } ] }, { "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.", "comments": "If both identifier and ref elements are present they shall refer to the same thing.", "min": 0, "max": "1", "base": { "path": "DocumentManifest.related.identifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "isSummary": true }, { "path": "DocumentManifest.related.ref", "short": "Related Resource", "definition": "Related Resource to this DocumentManifest. For example, Order, DiagnosticOrder, Procedure, EligibilityRequest, etc.", "comments": "If both identifier and ref elements are present they shall refer to the same thing.", "min": 0, "max": "1", "base": { "path": "DocumentManifest.related.ref", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "isSummary": true } ] }, "differential": { "element": [ { "path": "DocumentManifest", "name": "XDSDocumentManifest", "short": "SubmissionSet", "definition": "A manifest that defines a set of documents.", "min": 0, "max": "*", "type": [ { "code": "DocumentManifest" } ] }, { "path": "DocumentManifest.masterIdentifier", "short": "SubmissionSet.uniqueId", "definition": "A globally unique identifier for the SubmissionSet assigned by the creating entity.", "min": 1, "max": "1" }, { "path": "DocumentManifest.subject", "short": "SubmissionSet.patientId", "definition": "the subject of care whose longitudinal record is being reflected in this SubmissionSet.", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ] }, { "path": "DocumentManifest.recipient", "short": "SubmissionSet.intendedRecipient ", "definition": "The organization(s) or person(s) for whom the SubmissionSet is intended.", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "path": "DocumentManifest.type", "short": "SubmissionSet.contentTypeCode", "definition": "The code specifying the type of clinical activity that resulted in placing the documents in this SubmissionSet.", "type": [ { "code": "CodeableConcept" } ] }, { "path": "DocumentManifest.author", "short": "SubmissionSet.author", "definition": "The humans and/or machines that authored the document in the SubmissionSet. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty.", "min": 1, "max": "*", "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] }, { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] } ] }, { "path": "DocumentManifest.created", "short": "SubmissionSet.submissionTime", "definition": "Point in time at the creating entity when the SubmissionSet was created.", "type": [ { "code": "dateTime" } ] }, { "path": "DocumentManifest.source", "short": "SubmissionSet.sourceId", "definition": "OID identifying the instance of the creating entity that contributed the SubmissionSet.", "type": [ { "code": "uri" } ] }, { "path": "DocumentManifest.status", "short": "SubmissionSet.availabilityStatus", "definition": "The lifecycle status of the SubmissionSet.", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "The status of the document reference.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/document-reference-status" } } }, { "path": "DocumentManifest.description", "short": "SubmissionSet.title", "definition": "Human-readable description of the source document. This is sometimes known as the \"title\".", "type": [ { "code": "string" } ] }, { "path": "DocumentManifest.content", "short": "SubmissionSet.documentEntry", "definition": "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." } ] } }