OperationDefinition-CDR-DocumentReference-MarkPotentiallyMisfiled

Overview

Marks an identified DocumentReference as potentially misfiled and initiates the document misfile review workflow. The operation may be invoked at either the DocumentReference type level, with the target DocumentReference identified using the documentIdentifier input parameter, or at the instance level, with the target DocumentReference identified by the logical id in the request URL.

On successful execution, the CDR adds a meta tag to the DocumentReference to indicate that it is potentially misfiled and creates a Task with code review-document-misfile. When invoked at the type level, documentIdentifier SHALL be supplied. When invoked at the instance level, documentIdentifier SHALL NOT be supplied because the target DocumentReference is identified by the logical id in the request URL.

Formal Views of Profile Content

  • Overview
  • Table
  • XML
  • JSON
OperationDefinition
OperationDefinition.id[0]CDR-DocumentReference-MarkPotentiallyMisfiled
OperationDefinition.url[0]https://fhir.nhs.wales/OperationDefinition/CDR-DocumentReference-MarkPotentiallyMisfiled
OperationDefinition.version[0]0.3
OperationDefinition.name[0]CDRDocumentReferenceMarkPotentiallyMisfiled
OperationDefinition.title[0]CDR Mark DocumentReference as Potentially Misfiled
OperationDefinition.status[0]draft
OperationDefinition.kind[0]operation
OperationDefinition.description[0]Marks an identified DocumentReference as potentially misfiled and initiates the document misfile review workflow. The operation may be invoked at either the DocumentReference type level, with the target DocumentReference identified using the documentIdentifier input parameter, or at the instance level, with the target DocumentReference identified by the logical id in the request URL.
OperationDefinition.affectsState[0]True
OperationDefinition.code[0]mark-potentially-misfiled
OperationDefinition.comment[0]On successful execution, the CDR adds a meta tag to the DocumentReference to indicate that it is potentially misfiled and creates a Task with code review-document-misfile. When invoked at the type level, documentIdentifier SHALL be supplied. When invoked at the instance level, documentIdentifier SHALL NOT be supplied because the target DocumentReference is identified by the logical id in the request URL.
OperationDefinition.resource[0]DocumentReference
OperationDefinition.system[0]False
OperationDefinition.type[0]True
OperationDefinition.instance[0]True
OperationDefinition.parameter[0].name[0]documentIdentifier
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]0
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]The business identifier of the DocumentReference to be marked as potentially misfiled. This parameter is required when the operation is invoked at the DocumentReference type level and SHALL NOT be supplied when the operation is invoked at the instance level. The server searches DocumentReference.identifier using both Identifier.system and Identifier.value. If no matching DocumentReference exists, or if the identifier does not resolve unambiguously to a single DocumentReference, the server returns an error.
OperationDefinition.parameter[0].type[0]Identifier
OperationDefinition.parameter[1].name[0]source
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]1
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]The source Device from which the operation request originated. The CDR uses a business identifier of type applicationInstanceId provided in Device.identifier to determine if the Device already exists. If no matching Device record exists, the server will return an error.
OperationDefinition.parameter[1].type[0]Device
OperationDefinition.parameter[2].name[0]timestamp
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]0
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]The date and time at which the user marked the document as potentially misfiled. If not supplied, the server uses the date and time at which the operation is processed.
OperationDefinition.parameter[2].type[0]dateTime
OperationDefinition.parameter[3].name[0]requester
OperationDefinition.parameter[3].use[0]in
OperationDefinition.parameter[3].min[0]1
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]The Practitioner requesting that the document be marked as potentially misfiled. The CDR uses the business identifier provided in Practitioner.identifier to determine whether the Practitioner already exists. If no matching Practitioner record exists, the server will return an error.
OperationDefinition.parameter[3].type[0]Practitioner
OperationDefinition.parameter[4].name[0]misfileReason
OperationDefinition.parameter[4].use[0]in
OperationDefinition.parameter[4].min[0]1
OperationDefinition.parameter[4].max[0]1
OperationDefinition.parameter[4].documentation[0]The reason the requester considers the document to be potentially misfiled.
OperationDefinition.parameter[4].type[0]string
OperationDefinition.parameter[5].name[0]return
OperationDefinition.parameter[5].use[0]out
OperationDefinition.parameter[5].min[0]1
OperationDefinition.parameter[5].max[0]1
OperationDefinition.parameter[5].documentation[0]The Task created to manage review of the potentially misfiled document. The Task code is review-document-misfile.
OperationDefinition.parameter[5].type[0]Task
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="CDR-DocumentReference-MarkPotentiallyMisfiled" />
<url value="https://fhir.nhs.wales/OperationDefinition/CDR-DocumentReference-MarkPotentiallyMisfiled" />
<version value="0.3" />
<name value="CDRDocumentReferenceMarkPotentiallyMisfiled" />
<title value="CDR Mark DocumentReference as Potentially Misfiled" />
<status value="draft" />
<kind value="operation" />
<description value="Marks an identified DocumentReference as potentially misfiled and initiates the document misfile review workflow. The operation may be invoked at either the DocumentReference type level, with the target DocumentReference identified using the documentIdentifier input parameter, or at the instance level, with the target DocumentReference identified by the logical id in the request URL." />
<affectsState value="true" />
<code value="mark-potentially-misfiled" />
<comment value="On successful execution, the CDR adds a meta tag to the DocumentReference to indicate that it is potentially misfiled and creates a Task with code review-document-misfile. When invoked at the type level, documentIdentifier SHALL be supplied. When invoked at the instance level, documentIdentifier SHALL NOT be supplied because the target DocumentReference is identified by the logical id in the request URL." />
<resource value="DocumentReference" />
<system value="false" />
<type value="true" />
<instance value="true" />
<parameter>
<name value="documentIdentifier" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The business identifier of the DocumentReference to be marked as potentially misfiled. This parameter is required when the operation is invoked at the DocumentReference type level and SHALL NOT be supplied when the operation is invoked at the instance level. The server searches DocumentReference.identifier using both Identifier.system and Identifier.value. If no matching DocumentReference exists, or if the identifier does not resolve unambiguously to a single DocumentReference, the server returns an error." />
<type value="Identifier" />
</parameter>
<parameter>
<name value="source" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The source Device from which the operation request originated. The CDR uses a business identifier of type applicationInstanceId provided in Device.identifier to determine if the Device already exists. If no matching Device record exists, the server will return an error." />
<type value="Device" />
</parameter>
<parameter>
<name value="timestamp" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="The date and time at which the user marked the document as potentially misfiled. If not supplied, the server uses the date and time at which the operation is processed." />
<type value="dateTime" />
</parameter>
<parameter>
<name value="requester" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The Practitioner requesting that the document be marked as potentially misfiled. The CDR uses the business identifier provided in Practitioner.identifier to determine whether the Practitioner already exists. If no matching Practitioner record exists, the server will return an error." />
<type value="Practitioner" />
</parameter>
<parameter>
<name value="misfileReason" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The reason the requester considers the document to be potentially misfiled." />
<type value="string" />
</parameter>
<parameter>
<name value="return" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The Task created to manage review of the potentially misfiled document. The Task code is review-document-misfile." />
<type value="Task" />
</parameter>
</OperationDefinition>
{
"resourceType": "OperationDefinition",
"id": "CDR-DocumentReference-MarkPotentiallyMisfiled",
"url": "https://fhir.nhs.wales/OperationDefinition/CDR-DocumentReference-MarkPotentiallyMisfiled",
"version": "0.3",
"name": "CDRDocumentReferenceMarkPotentiallyMisfiled",
"title": "CDR Mark DocumentReference as Potentially Misfiled",
"status": "draft",
"kind": "operation",
"description": "Marks an identified DocumentReference as potentially misfiled and initiates the document misfile review workflow. The operation may be invoked at either the DocumentReference type level, with the target DocumentReference identified using the documentIdentifier input parameter, or at the instance level, with the target DocumentReference identified by the logical id in the request URL.",
"affectsState": true,
"code": "mark-potentially-misfiled",
"comment": "On successful execution, the CDR adds a meta tag to the DocumentReference to indicate that it is potentially misfiled and creates a Task with code review-document-misfile. When invoked at the type level, documentIdentifier SHALL be supplied. When invoked at the instance level, documentIdentifier SHALL NOT be supplied because the target DocumentReference is identified by the logical id in the request URL.",
"resource": [
"DocumentReference"
],
"system": false,
"type": true,
"instance": true,
"parameter": [
{
"name": "documentIdentifier",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The business identifier of the DocumentReference to be marked as potentially misfiled. This parameter is required when the operation is invoked at the DocumentReference type level and SHALL NOT be supplied when the operation is invoked at the instance level. The server searches DocumentReference.identifier using both Identifier.system and Identifier.value. If no matching DocumentReference exists, or if the identifier does not resolve unambiguously to a single DocumentReference, the server returns an error.",
"type": "Identifier"
},
{
"name": "source",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The source Device from which the operation request originated. The CDR uses a business identifier of type applicationInstanceId provided in Device.identifier to determine if the Device already exists. If no matching Device record exists, the server will return an error.",
"type": "Device"
},
{
"name": "timestamp",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The date and time at which the user marked the document as potentially misfiled. If not supplied, the server uses the date and time at which the operation is processed.",
"type": "dateTime"
},
{
"name": "requester",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The Practitioner requesting that the document be marked as potentially misfiled. The CDR uses the business identifier provided in Practitioner.identifier to determine whether the Practitioner already exists. If no matching Practitioner record exists, the server will return an error.",
"type": "Practitioner"
},
{
"name": "misfileReason",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The reason the requester considers the document to be potentially misfiled.",
"type": "string"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The Task created to manage review of the potentially misfiled document. The Task code is review-document-misfile.",
"type": "Task"
}
]
}

Example FHIR Resource