FHIR IG analytics| Package | dk.ehealth.sundhed.fhir.ig.core |
| Resource Type | OperationDefinition |
| Id | OperationDefinition-Binary-t-retrieve-document.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/fut-infrastructure/implementation-guide/OperationDefinition-Binary-t-retrieve-document.html |
| URL | http://ehealth.sundhed.dk/fhir/OperationDefinition/Binary-t-retrieve-document |
| Version | 8.0.0 |
| Status | active |
| Date | 2026-02-18T09:10:00+00:00 |
| Name | retrieve-document |
| Title | Retrieve document |
| Realm | dk |
| Description | Input (url) is the element DocumentReference.content.attachment.url for metadata about the QRD/APD/PHMR document as returned from the DocumentReference search operation performing a query to national document sharing infrastructure. The url, which shall be used as-is in this operation, is an encoding of the XDS DocumentEntry.uniqueId, XDS DocumentEntry.repositoryUniqueId and XDS DocumentEntry.homeCommunityId metadata attributes needed to retrieve the document. Input (consentOverride) signifies, when set to true, that the retrieve of a document shall be performed with override of any withholding of information possibly performed by the national document sharing service in accordance with patient's consents. Override of consents constitutes a form of break-the-glass invocation, known in Danish as værdispring.The preferred method is to call this operation without consent override and to only call with consent override when necessary. Input (reason) is mandatory when input element consentOverride is set to true. The string input is intended as a placeholder for the user's rationale for choosing to override consents.The value is logged in the Infrastructure. |
| Type | true |
| Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition Binary-t-retrieve-document
URL: [base]/Binary/$retrieve-document
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | 1..1 | string (uri) | The URL identifying the document to retrieve | ||
| IN | consentOverride | 0..1 | boolean | Specifies if the retrieval of a document shall be performed with override of any withholding of information possibly performed by the national document sharing service in accordance with patient's consents | ||
| IN | reason | 0..1 | string | String specifying the reason for overriding consents when consentOverride is set to true | ||
| OUT | return | 0..1 | Binary |
FHIR
FHIRsmith{
"resourceType": "OperationDefinition",
"id": "Binary-t-retrieve-document",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://ehealth.sundhed.dk/fhir/OperationDefinition/Binary-t-retrieve-document",
"version": "8.0.0",
"name": "retrieve-document",
"title": "Retrieve document",
"status": "active",
"kind": "operation",
"date": "2026-02-18T09:10:00+00:00",
"publisher": "Den telemedicinske infrastruktur (eHealth Infrastructure)",
"contact": [
{
"name": "Den telemedicinske infrastruktur (eHealth Infrastructure)",
"telecom": [
{
"system": "url",
"value": "http://ehealth.sundhed.dk"
}
]
}
],
"description": "Input (url) is the element DocumentReference.content.attachment.url for metadata about the QRD/APD/PHMR document as returned from the DocumentReference search operation performing a query to national document sharing infrastructure. The url, which shall be used as-is in this operation, is an encoding of the XDS DocumentEntry.uniqueId, XDS DocumentEntry.repositoryUniqueId and XDS DocumentEntry.homeCommunityId metadata attributes needed to retrieve the document. Input (consentOverride) signifies, when set to true, that the retrieve of a document shall be performed with override of any withholding of information possibly performed by the national document sharing service in accordance with patient's consents. Override of consents constitutes a form of break-the-glass invocation, known in Danish as værdispring.The preferred method is to call this operation without consent override and to only call with consent override when necessary. Input (reason) is mandatory when input element consentOverride is set to true. The string input is intended as a placeholder for the user's rationale for choosing to override consents.The value is logged in the Infrastructure.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "DK",
"display": "Denmark"
}
]
}
],
"affectsState": false,
"code": "retrieve-document",
"resource": [
"Binary"
],
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "url",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The URL identifying the document to retrieve",
"type": "string",
"searchType": "uri"
},
{
"name": "consentOverride",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Specifies if the retrieval of a document shall be performed with override of any withholding of information possibly performed by the national document sharing service in accordance with patient's consents",
"type": "boolean"
},
{
"name": "reason",
"use": "in",
"min": 0,
"max": "1",
"documentation": "String specifying the reason for overriding consents when consentOverride is set to true",
"type": "string"
},
{
"name": "return",
"use": "out",
"min": 0,
"max": "1",
"type": "Binary"
}
]
}