FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageihe.iti.mhd
Resource TypeOperationDefinition
IdOperationDefinition-generate-metadata.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/IHE/ITI.MHD/OperationDefinition-generate-metadata.html
URLhttps://profiles.ihe.net/ITI/MHD/OperationDefinition/generate-metadata
Version4.2.4-current
Statusactive
Date2025-11-03T18:52:36+00:00
NameGenerateMetadata
TitleGenerate a DocumentReference from a document
Realmuv
Authorityihe
DescriptionGenerate Metadata [ITI-106](ITI-106.html) transaction Operation.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
IHE.MHD.DocumentRecipient.GenerateDocument Recipient implementing Generate Metadata Option
IHE.MHD.DocumentSource.GenerateDocument Source (publisher) implementing the Generate Metadata Option
ISiKCapabilityStatementMetadatenErzeugenRolleISiK CapabilityStatement Metadaten Erzeugen Rolle
dokumentenaustausch-serverISiK CapabilityStatement Dokumentenaustausch Server

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition generate-metadata

URL: [base]/DocumentReference/$generate-metadata

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INdocument1..1Resource (Binary, Bundle)

ITI-106 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
  • example of input Parameters
OUTDocumentReference1..1Reference (MHD DocumentReference Minimal)

ITI-106 Generate Metadata Response Message

  • Output is a reference to a MHV DocumentReference with metadata generated from the document

Source1

{
  "resourceType": "OperationDefinition",
  "id": "generate-metadata",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/ITI/MHD/OperationDefinition/generate-metadata",
  "version": "4.2.4-current",
  "name": "GenerateMetadata",
  "title": "Generate a DocumentReference from a document",
  "status": "active",
  "kind": "operation",
  "experimental": false,
  "date": "2025-11-03T18:52:36+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",
          "display": "World"
        }
      ]
    }
  ],
  "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"
      ]
    }
  ]
}