FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/annotate

Packagehl7.eu.fhir.gh
TypeOperationDefinition
Idannotate
FHIR VersionR5
Sourcehttp://hl7.eu/fhir/ig/gravitate-health/https://build.fhir.org/ig/hl7-eu/gravitate-health/OperationDefinition-annotate.html
URLhttp://hl7.eu/fhir/ig/gravitate-health/OperationDefinition/annotate
Version0.1.0
Statusactive
Date2025-07-18T15:55:38+00:00
Nameannotate
Titleannotate
Realmeu
Authorityhl7
DescriptionThis operation calculates an annotated version of an ePI as well as the separate extracts. The ePI can be delivered either as a `Bundle` or by using an `Identifier` of the bundle. Whether the support of both `Identifier` and `Bundle` continues to be supported currently remains unknown.
Typefalse
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: OperationDefinition annotate

URL: [base]/$annotate

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INepi0..1Bundle

ePI Document Bundle

INepi-identifier0..1Identifier

ePI Document Identifier

OUTreturnEpi1..1Bundle

Preprocessed epi Bundle

OUTreturnEpiExtracts1..1Bundle

Preprocessed epi Bundle extracts


Source

{
  "resourceType": "OperationDefinition",
  "id": "annotate",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.eu/fhir/ig/gravitate-health/OperationDefinition/annotate",
  "version": "0.1.0",
  "name": "annotate",
  "title": "annotate",
  "status": "active",
  "kind": "operation",
  "date": "2025-07-18T15:55:38+00:00",
  "publisher": "Gravitate Health Project",
  "contact": [
    {
      "name": "Gravitate Health Project",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.gravitatehealth.eu/"
        }
      ]
    },
    {
      "name": "Gravitate Health Project",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.gravitatehealth.eu/"
        }
      ]
    }
  ],
  "description": "This operation calculates an annotated version of an ePI as well as the separate extracts. \n\nThe ePI can be delivered either as a `Bundle` or by using an `Identifier` of the bundle. Whether the support of both `Identifier` and `Bundle` continues to be supported currently remains unknown.\n\n",
  "affectsState": false,
  "code": "annotate",
  "system": true,
  "type": false,
  "instance": false,
  "parameter": [
    {
      "name": "epi",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "ePI Document Bundle",
      "type": "Bundle"
    },
    {
      "name": "epi-identifier",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "ePI Document Identifier",
      "type": "Identifier"
    },
    {
      "name": "returnEpi",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "Preprocessed epi Bundle",
      "type": "Bundle"
    },
    {
      "name": "returnEpiExtracts",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "Preprocessed epi Bundle extracts",
      "type": "Bundle"
    }
  ]
}