Mobile access to Health Documents (MHD)
4.2.3-current - ci-build International flag

Mobile access to Health Documents (MHD), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 4.2.3-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.MHD/ and changes regularly. See the Directory of published versions

: Generate a DocumentReference from a document - XML Representation

Active as of 2025-10-06

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="generate-metadata"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition generate-metadata</b></p><a name="generate-metadata"> </a><a name="hcgenerate-metadata"> </a><p>URL: [base]/DocumentReference/$generate-metadata</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>document</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/resource.html">Resource</a> (<a href="http://hl7.org/fhir/R4/binary.html" title="http://hl7.org/fhir/StructureDefinition/Binary">Binary</a>, <a href="http://hl7.org/fhir/R4/bundle.html" title="http://hl7.org/fhir/StructureDefinition/Bundle">Bundle</a>)</td><td/><td><div><p><a href="ITI-106.html#2310641-generate-metadata-request-message">ITI-106 Generate Metadata Request Message</a></p>
<ul>
<li>the document that is either a Binary or a document Bundle
<ul>
<li>Binary 0..1 the <em>document</em> in Binary Resource format. Usually used with CDA documents.</li>
<li>Bundle 0..1 the <em>document</em> in FHIR-Document form of a Bundle of kind Document</li>
</ul>
</li>
<li>representative profile of Input Parameters <a href="StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.In.html">IHE.MHD.GenerateMetadata.Parameters.In</a></li>
<li>example of <a href="StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.In-examples.html">input Parameters</a></li>
</ul>
</div></td></tr><tr><td>OUT</td><td>DocumentReference</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-IHE.MHD.Minimal.DocumentReference.html" title="https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference">MHD DocumentReference Minimal</a>)</td><td/><td><div><p><a href="ITI-106.html#2310642-generate-metadata-response-message">ITI-106 Generate Metadata Response Message</a></p>
<ul>
<li>Output is a reference to a MHV DocumentReference with metadata generated from the <em>document</em></li>
</ul>
</div></td></tr></table></div>
  </text>
  <url
       value="https://profiles.ihe.net/ITI/MHD/OperationDefinition/generate-metadata"/>
  <version value="4.2.3-current"/>
  <name value="GenerateMetadata"/>
  <title value="Generate a DocumentReference from a document"/>
  <status value="active"/>
  <kind value="operation"/>
  <experimental value="false"/>
  <date value="2025-10-06T18:39:00+00:00"/>
  <publisher value="IHE IT Infrastructure Technical Committee"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="https://www.ihe.net/ihe_domains/it_infrastructure/"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <contact>
    <name value="IHE IT Infrastructure Technical Committee"/>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <description
               value="Generate Metadata [ITI-106](ITI-106.html) transaction Operation."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <affectsState value="true"/>
  <code value="generate-metadata"/>
  <resource value="DocumentReference"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="document"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="[ITI-106 Generate Metadata Request Message](ITI-106.html#2310641-generate-metadata-request-message)
- the document that is either a Binary or a document Bundle
  - Binary 0..1 the *document* in Binary Resource format. Usually used with CDA documents.
  - Bundle 0..1 the *document* in FHIR-Document form of a Bundle of kind Document
- representative profile of Input Parameters [IHE.MHD.GenerateMetadata.Parameters.In](StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.In.html)
- example of [input Parameters](StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.In-examples.html)"/>
    <type value="Resource"/>
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Binary"/>
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
  </parameter>
  <parameter>
    <name value="DocumentReference"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="[ITI-106 Generate Metadata Response Message](ITI-106.html#2310642-generate-metadata-response-message)
- Output is a reference to a MHV DocumentReference with metadata generated from the *document*"/>
    <type value="Reference"/>
    <targetProfile
                   value="https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference"/>
  </parameter>
</OperationDefinition>