eHealth Infrastructure - Local Development build (v3.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-05-27 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="DocumentReference-t-deprecate-document"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/DocumentReference/$deprecate-document</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>documentId</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#token">token</a>)</td><td/><td/></tr><tr><td>IN</td><td>cpr</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td/><td/></tr></table></div>
</text>
<url
value="https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/DocumentReference-t-deprecate-document"/>
<version value="3.1.0"/>
<name value="deprecate-document"/>
<title value="Deprecate document"/>
<status value="active"/>
<kind value="operation"/>
<date value="2024-05-27T08:37:34+00:00"/>
<publisher
value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
<contact>
<name value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
<telecom>
<system value="url"/>
<value value="http://ehealth.sundhed.dk"/>
</telecom>
</contact>
<description
value="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."/>
<affectsState value="true"/>
<code value="deprecate-document"/>
<resource value="DocumentReference"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="documentId"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="cpr"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
<searchType value="string"/>
</parameter>
</OperationDefinition>