Mobile access to Health Documents (MHD)
5.0.0-current - ci-build

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 5.0.0-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 - JSON Representation

Active as of 2025-10-13

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "generate-metadata",
      "text" : {
        "status" : "generated",
        "div" : "<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/R5/resource.html\">Resource</a> (<a href=\"http://hl7.org/fhir/R5/binary.html\" title=\"http://hl7.org/fhir/StructureDefinition/Binary\">Binary</a>, <a href=\"http://hl7.org/fhir/R5/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>\n<ul>\n<li>the document that is either a Binary or a document Bundle\n<ul>\n<li>Binary 0..1 the <em>document</em> in Binary Resource format. Usually used with CDA documents.</li>\n<li>Bundle 0..1 the <em>document</em> in FHIR-Document form of a Bundle of kind Document</li>\n</ul>\n</li>\n<li>representative profile of Input Parameters <a href=\"StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.In.html\">IHE.MHD.GenerateMetadata.Parameters.In</a></li>\n<li>example of <a href=\"StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.In-examples.html\">input Parameters</a></li>\n</ul>\n</div></td></tr><tr><td>OUT</td><td>DocumentReference</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R5/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>\n<ul>\n<li>Output is a reference to a MHV DocumentReference with metadata generated from the <em>document</em></li>\n</ul>\n</div></td></tr></table></div>"
      },
      "url" : "https://profiles.ihe.net/ITI/MHD/OperationDefinition/generate-metadata",
      "version" : "5.0.0-current",
      "name" : "GenerateMetadata",
      "title" : "Generate a DocumentReference from a document",
      "status" : "active",
      "kind" : "operation",
      "experimental" : false,
      "date" : "2025-10-13T19:00:21+00:00",
      "publisher" : "IHE IT Infrastructure Technical Committee",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
            }
          ]
        },
        {
          "telecom" : [
            {
              "system" : "email",
              "value" : "iti@ihe.net"
            }
          ]
        },
        {
          "name" : "IHE IT Infrastructure Technical Committee",
          "telecom" : [
            {
              "system" : "email",
              "value" : "iti@ihe.net"
            }
          ]
        }
      ],
      "description" : "Generate Metadata [ITI-106](ITI-106.html) transaction Operation.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
              "code" : "001"
            }
          ]
        }
      ],
      "affectsState" : true,
      "code" : "generate-metadata",
      "resource" : [
        "DocumentReference"
      ],
      "system" : false,
      "type" : true,
      "instance" : false,
      "parameter" : [
        {
          "name" : "document",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "[ITI-106 Generate Metadata Request Message](ITI-106.html#2310641-generate-metadata-request-message)\n- the document that is either a Binary or a document Bundle\n  - Binary 0..1 the *document* in Binary Resource format. Usually used with CDA documents.\n  - Bundle 0..1 the *document* in FHIR-Document form of a Bundle of kind Document\n- representative profile of Input Parameters [IHE.MHD.GenerateMetadata.Parameters.In](StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.In.html)\n- example of [input Parameters](StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.In-examples.html)",
          "type" : "Resource",
          "targetProfile" : [
            🔗 "http://hl7.org/fhir/StructureDefinition/Binary"🔗 ,
            "http://hl7.org/fhir/StructureDefinition/Bundle"
          ]
        },
        {
          "name" : "DocumentReference",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "[ITI-106 Generate Metadata Response Message](ITI-106.html#2310642-generate-metadata-response-message)\n- Output is a reference to a MHV DocumentReference with metadata generated from the *document*",
          "type" : "Reference",
          "targetProfile" : [
            🔗 "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference"
          ]
        }
      ]
    }