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

FHIR IG Statistics: OperationDefinition/DocumentReference-t-deprecate-document

Packagedk.ehealth.sundhed.fhir.ig.core
TypeOperationDefinition
IdDocumentReference-t-deprecate-document
FHIR VersionR4
Sourcehttp://ehealth.sundhed.dk/fhir/https://build.fhir.org/ig/fut-infrastructure/implementation-guide/OperationDefinition-DocumentReference-t-deprecate-document.html
URLhttps://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/DocumentReference-t-deprecate-document
Version3.5.1
Statusactive
Date2025-07-03T10:29:25+00:00
Namedeprecate-document
TitleDeprecate document
Realmdk
DescriptionDeprecates a shared document. The operation takes a documentIdentifier and cpr-number as parameters and finds the DocumentReference with the corresponding masterIdentifier. masterIdentifier should be unique for DocumentReference so if less than 0 or more than 1 are found the operation throws and exception. If the found documentReference has a patient which cpr number matches the provided value the document is deprecated. iti-57 is used to deprecate the document on XDS. On successthe documentReference status is updated to superseded and updated in the database.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
document-transformationdocument-transformation

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: Operationsdefinition DocumentReference-t-deprecate-document

URL: [base]/DocumentReference/$deprecate-document

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INdocumentId0..1string
(token)
INcpr0..1string
(string)

Source

{
  "resourceType": "OperationDefinition",
  "id": "DocumentReference-t-deprecate-document",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/DocumentReference-t-deprecate-document",
  "version": "3.5.1",
  "name": "deprecate-document",
  "title": "Deprecate document",
  "status": "active",
  "kind": "operation",
  "date": "2025-07-03T10:29:25+00:00",
  "publisher": "Den telemedicinske infrastruktur (eHealth Infrastructure)",
  "contact": [
    {
      "name": "Den telemedicinske infrastruktur (eHealth Infrastructure)",
      "telecom": [
        {
          "system": "url",
          "value": "http://ehealth.sundhed.dk"
        }
      ]
    }
  ],
  "description": "Deprecates a shared document. The operation takes a documentIdentifier and cpr-number as parameters and finds the DocumentReference with the corresponding masterIdentifier. masterIdentifier should be unique for DocumentReference so if less than 0 or more than 1 are found the operation throws and exception. If the found documentReference has a patient which cpr number matches the provided value the document is deprecated. iti-57 is used to deprecate the document on XDS. On successthe documentReference status is updated to superseded and updated in the database.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "DK",
          "display": "Denmark"
        }
      ]
    }
  ],
  "affectsState": true,
  "code": "deprecate-document",
  "resource": [
    "DocumentReference"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "documentId",
      "use": "in",
      "min": 0,
      "max": "1",
      "type": "string",
      "searchType": "token"
    },
    {
      "name": "cpr",
      "use": "in",
      "min": 0,
      "max": "1",
      "type": "string",
      "searchType": "string"
    }
  ]
}