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

FHIR IG analytics

Packagech.fhir.ig.ch-health-dossier
Resource TypeOperationDefinition
IdOperationDefinition-CHMhdPurge.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/ehealthsuisse/ch-health-dossier/OperationDefinition-CHMhdPurge.html
URLhttp://fhir.ch/ig/ch-health-dossier/OperationDefinition/CHMhdPurge
Version1.0.0-preview
Statusactive
Date2026-10-22T15:03:55+00:00
NameCHMhdPurge
TitleCH MHD $purge
Realmch
Authorityhl7
DescriptionThis operation implements the [Purge Document \[CH:MHD-2\]](ch-mhd-2.html) transaction. It irrevocably removes a document, the DocumentReference with all its versions and the document it references, from the health dossier of a holder. The operation is synchronous.
Typefalse
Kindoperation

Resources that use this resource

CapabilityStatement
ch.fhir.ig.ch-health-dossier#currentCH.MHD.DocumentResponderMHD Document Responder (server)
ch.fhir.ig.ch-health-dossier#currentCH.MHD.DocumentSourceMHD Document Source (client)

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: OperationDefinition CHMhdPurge

URL: [base]/DocumentReference/[id]/$purge

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
OUTreturn1..1OperationOutcome

Outcome of the purge. On success an issue with severity information and code informational, otherwise the error which caused the purge to fail.


Source1

{
  "resourceType": "OperationDefinition",
  "id": "CHMhdPurge",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.ch/ig/ch-health-dossier/OperationDefinition/CHMhdPurge",
  "version": "1.0.0-preview",
  "name": "CHMhdPurge",
  "title": "CH MHD $purge",
  "status": "active",
  "kind": "operation",
  "date": "2026-10-22T15:03:55+00:00",
  "publisher": "eHealth Suisse",
  "contact": [
    {
      "name": "eHealth Suisse",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.e-health-suisse.ch"
        }
      ]
    },
    {
      "name": "eHealth Suisse",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.e-health-suisse.ch",
          "use": "work"
        }
      ]
    }
  ],
  "description": "This operation implements the [Purge Document \\[CH:MHD-2\\]](ch-mhd-2.html) transaction. It irrevocably removes a\ndocument, the DocumentReference with all its versions and the document it references, from the health dossier of a\nholder. The operation is synchronous.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "CH"
        }
      ]
    }
  ],
  "affectsState": true,
  "code": "purge",
  "resource": [
    "DocumentReference"
  ],
  "system": false,
  "type": false,
  "instance": true,
  "parameter": [
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "Outcome of the purge. On success an issue with severity information and code informational, otherwise the error which caused the purge to fail.",
      "type": "OperationOutcome"
    }
  ]
}