StructureDefinition: DocumentManifest

DocumentManifest

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="xds-documentmanifest"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/xds-documentmanifest"/>
  <name value="XDS profile for Document Reference"/>
  <publisher value="HL7"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org"/>
    </telecom>
  </contact>
  <description value="SubmissionSet"/>
  <status value="draft"/>
  <date value="2012-06-24"/>
  <type value="constraint"/>
  <abstract value="false"/>
  <base value="http://hl7.org/fhir/StructureDefinition/DocumentManifest"/>
  <snapshot>
    <element>
      <path value="DocumentManifest"/>
      <name value="DocumentManifest"/>
      <short value="SubmissionSet"/>
      <definition value="A manifest that defines a set of documents."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="DocumentManifest"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="Act[classCode=FOLDER, moodCode=EVN]"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments value="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 value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="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 value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="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 value="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 value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="DocumentManifest.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="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 value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <strength value="required"/>
        <description value="A human language"/>
        <valueSetUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="DocumentManifest.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition value="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 &quot;clinically
       safe&quot; 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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have
       a narrative."/>
      <alias value="narrative"/>
      <alias value="html"/>
      <alias value="xhtml"/>
      <alias value="display"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Narrative"/>
      </type>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.contained"/>
      <short value="Contained, inline Resources"/>
      <definition value="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 value="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 value="inline resources"/>
      <alias value="anonymous resources"/>
      <alias value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="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 value="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 value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="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 value="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 value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.masterIdentifier"/>
      <short value="Unique Identifier for the set of documents"/>
      <definition value="A single identifier that uniquely identifies this manifest. Principally used to refer
       to the manifest in non-FHIR contexts."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Identifier"/>
      </type>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet.uniqueId"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="id [need a list semantic to indicate order matters]"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.identifier"/>
      <short value="SubmissionSet.uniqueId"/>
      <definition value="A globally unique identifier for the SubmissionSet assigned by the creating entity."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Identifier"/>
      </type>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet.entryUUID"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <map value="TXA-16-Unique Document File Name?"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".id / .setId"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.subject"/>
      <short value="SubmissionSet.patientId"/>
      <definition value="the subject of care whose longitudinal record is being reflected in this SubmissionSet."/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet.patientId"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=SBJ].role"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.recipient"/>
      <short value="SubmissionSet.intendedRecipient "/>
      <definition value="The organization(s) or person(s) for whom the SubmissionSet is intended."/>
      <comments value="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 value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/>
      </type>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet.intendedRecipient"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=IRCP].role"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.type"/>
      <short value="SubmissionSet.contentTypeCode"/>
      <definition value="The code specifying the type of clinical activity that resulted in placing the documents
       in this SubmissionSet."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <name value="DocumentC80Type"/>
        <strength value="preferred"/>
        <description value="Precice type of clinical document"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/c80-doc-typecodes"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet.contentTypeCode"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".code"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.author"/>
      <short value="SubmissionSet.author"/>
      <definition value="The humans and/or machines that authored the document  in the SubmissionSet. This attribute
       contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty."/>
      <comments value="Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant)."/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Device"/>
      </type>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet.author"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].role"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.created"/>
      <short value="SubmissionSet.submissionTime"/>
      <definition value="Point in time at the creating entity when the SubmissionSet was created."/>
      <comments value="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 value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet.submissionTime"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].time"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.source"/>
      <short value="SubmissionSet.sourceId"/>
      <definition value="OID identifying the instance of the creating entity that contributed the SubmissionSet."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet.sourceId"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=PFM].time"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.status"/>
      <short value="SubmissionSet.availabilityStatus"/>
      <definition value="The lifecycle status of the SubmissionSet."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <binding>
        <name value="DocumentReferenceStatus"/>
        <strength value="required"/>
        <description value="The status of the document reference"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/document-reference-status"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet status"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".statusCode"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.description"/>
      <short value="SubmissionSet.title"/>
      <definition value="Human-readable description of the source document. This is sometimes known as the &quot;title&quot;."/>
      <comments value="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 &quot;consultation&quot; or &quot;progress note&quot;)."/>
      <requirements value="Helps humans to assess whether the document is of interest."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet.title"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".title"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.content"/>
      <short value="SubmissionSet.documentEntry"/>
      <definition value="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 value="1"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/DocumentReference"/>
      </type>
      <mapping>
        <identity value="xds"/>
        <map value="SubmissionSet DocumentEntry(s)"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".outboundRelationship[typeCode=COMP].target"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.related"/>
      <short value="Related things"/>
      <definition value="Related identifiers or resources associated with the DocumentManifest."/>
      <comments value="May be identifiers or resources that caused the DocumentManifest to be created."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="DocumentManifest.related.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.related.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="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 value="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 value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.related.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="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 value="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 value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="DocumentManifest.related.identifier"/>
      <short value="Related Identifier"/>
      <definition value="Related identifier to this DocumentManifest. If both id and ref are present they shall
       refer to the same thing."/>
      <comments value="Order numbers, accession numbers, XDW workflow numbers."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.related.ref"/>
      <short value="Related Resource"/>
      <definition value="Related Resource to this DocumentManifest. If both id and ref are present they shall refer
       to the same thing."/>
      <comments value="Order, DiagnosticOrder,  Procedure, EligibilityRequest, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Resource"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="DocumentManifest"/>
      <name value="DocumentManifest"/>
      <short value="SubmissionSet"/>
      <definition value="A manifest that defines a set of documents."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="DocumentManifest"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.confidentiality"/>
      <short value="SubmissionSet.confidentialityCode"/>
      <definition value="A code specifying the level of confidentiality of this set of Documents."/>
      <min value="0"/>
      <max value="0"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <name value="DocumentConfidentiality"/>
        <strength value="required"/>
        <description value="Codes specifying the level of confidentiality of the composition"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/v3/vs/Confidentiality"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="DocumentManifest.supercedes"/>
      <short value="todo"/>
      <definition value="If this document manifest replaces another."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/DocumentManifest"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.identifier"/>
      <short value="SubmissionSet.uniqueId"/>
      <definition value="A globally unique identifier for the SubmissionSet assigned by the creating entity."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.subject"/>
      <short value="SubmissionSet.patientId"/>
      <definition value="the subject of care whose longitudinal record is being reflected in this SubmissionSet."/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.recipient"/>
      <short value="SubmissionSet.intendedRecipient "/>
      <definition value="The organization(s) or person(s) for whom the SubmissionSet is intended."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.type"/>
      <short value="SubmissionSet.contentTypeCode"/>
      <definition value="The code specifying the type of clinical activity that resulted in placing the documents
       in this SubmissionSet."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.author"/>
      <short value="SubmissionSet.author"/>
      <definition value="The humans and/or machines that authored the document  in the SubmissionSet. This attribute
       contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty."/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Device"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.created"/>
      <short value="SubmissionSet.submissionTime"/>
      <definition value="Point in time at the creating entity when the SubmissionSet was created."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.source"/>
      <short value="SubmissionSet.sourceId"/>
      <definition value="OID identifying the instance of the creating entity that contributed the SubmissionSet."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.status"/>
      <short value="SubmissionSet.availabilityStatus"/>
      <definition value="The lifecycle status of the SubmissionSet."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="DocumentReferenceStatus"/>
        <strength value="required"/>
        <description value="The status of the document reference"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/document-reference-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="DocumentManifest.description"/>
      <short value="SubmissionSet.title"/>
      <definition value="Human-readable description of the source document. This is sometimes known as the &quot;title&quot;."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="DocumentManifest.content"/>
      <short value="SubmissionSet.documentEntry"/>
      <definition value="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 value="1"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/DocumentReference"/>
      </type>
    </element>
  </differential>
</StructureDefinition>