Safeguard API for Smart FOX - Local Development build (v4.2.3-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Generate a DocumentReference from a document - JSON Representation

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><p>Input parameters Profile:<a href=\"StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.In.html\">IHE MHD GenerateMetadata Parameters In</a></p><p>Output parameters Profile:<a href=\"StructureDefinition-IHE.MHD.GenerateMetadata.Parameters.Out.html\">IHE MHD GenerateMetadata Parameters Out</a></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></table></div>"
  },
  "url" : "https://profiles.ihe.net/ITI/MHD/OperationDefinition/generate-metadata",
  "version" : "4.2.3-current",
  "name" : "GenerateMetadata",
  "title" : "Generate a DocumentReference from a document",
  "status" : "active",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2025-09-25T09:37:46+00:00",
  "publisher" : "AIT Austrian Institute of Technology GmbH",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.smart-fox.at/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "contact@smart-fox.at"
        }
      ]
    },
    {
      "name" : "AIT Austrian Institute of Technology GmbH",
      "telecom" : [
        {
          "system" : "email",
          "value" : "contact@smart-fox.at"
        }
      ]
    }
  ],
  "description" : "A client can ask a server to generate a documentReference from a document.\nThe server reads the existing document and generates a matching DocumentReference resource, or returns one it has previously generated. \nThe server will persist the document and the DocumentReference; and may propagate based on grouping with other Actors.\nServers may be able to return or generate document references for the following types of content:\n- CDA\n- FHIR Document",
  "affectsState" : true,
  "code" : "generate-metadata",
  "resource" : [
    "DocumentReference"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "inputProfile" : "https://www.smart-fox.at/Safeguard-API/StructureDefinition/IHE.MHD.GenerateMetadata.Parameters.In",
  "outputProfile" : "https://www.smart-fox.at/Safeguard-API/StructureDefinition/IHE.MHD.GenerateMetadata.Parameters.Out"
}