| Package | hl7.eu.fhir.gh |
| Resource Type | OperationDefinition |
| Id | annotate |
| FHIR Version | R5 |
| Source | http://hl7.eu/fhir/ig/gravitate-health/https://build.fhir.org/ig/hl7-eu/gravitate-health/OperationDefinition-annotate.html |
| URL | http://hl7.eu/fhir/ig/gravitate-health/OperationDefinition/annotate |
| Version | 0.1.0 |
| Status | active |
| Date | 2025-07-25T07:27:16+00:00 |
| Name | annotate |
| Title | annotate |
| Realm | eu |
| Authority | hl7 |
| Description | This 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. |
| Type | false |
| Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition annotate
URL: [base]/$annotate
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | epi | 0..1 | Bundle | ePI Document Bundle | ||
| IN | epi-identifier | 0..1 | Identifier | ePI Document Identifier | ||
| OUT | returnEpi | 1..1 | Bundle | Preprocessed epi Bundle | ||
| OUT | returnEpiExtracts | 1..1 | Bundle | Preprocessed epi Bundle extracts |
{
"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-25T07:27:16+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"
}
]
}