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

FHIR IG Statistics: OperationDefinition/patient-link

Packagehl7.fhir.ee.mpi
TypeOperationDefinition
Idpatient-link
FHIR VersionR5
Sourcehttps://fhir.ee/file:///fsh/output/OperationDefinition-patient-link.html
URLhttps://fhir.ee/OperationDefinition/patient-link
Version1.0.0
Statusactive
Date2023-03-26T15:21:02+11:00
NameEEMPIPatientLink
TitlePatient Link
Realmee
Authorityhl7
DescriptionThe link operation is used to link two patient resources. One of the two patients is identified as the source and one as the target. The link with type 'replaces' created from source to destination patient, the another link with type 'replaced-byä created from destination to source patient. As result of linking the destination patient is deactivated.
Typetrue
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

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

URL: [base]/Patient/$link

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsource-patient0..1Reference

A direct resource reference to the source patient resource (this may include an identifier).

INsource-patient-identifier0..*Identifier

When source-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the source patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as part of a review by a user.

INtarget-patient0..1Reference

A direct resource reference to the target patient resource.

This is the surviving patient resource, the target for the link.

INtarget-patient-identifier0..*Identifier

When target-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the target patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as part of a review by a user.

OUTreturn1..1Patient

The status of the response will be one of:

  • 200 OK - If the merge request doesn't expect any issues (although warning may be present) for a preview, or was completed without issues if not a preview
  • 202 Accepted - The merge request has been accepted and does not expect any issues and will continue processing the merge in the background, and you can monitor the Task for completion
  • 400 Bad Request - There are errors in the input parameters that need to corrected
  • 422 Unprocessable Entity - Business rules prevent this merge from completing

The Parameters resource will include:

  • The Input parameters to the operation
  • An OperationOutcome containing errors, warnings, and information messages
  • The resulting merged Patient resource (or a patient reference if the patient is not committed)
  • Optionally a Task resource to track any additional processing that was required.

Source

{
  "resourceType": "OperationDefinition",
  "id": "patient-link",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    }
  ],
  "url": "https://fhir.ee/OperationDefinition/patient-link",
  "version": "1.0.0",
  "name": "EEMPIPatientLink",
  "title": "Patient Link",
  "status": "active",
  "kind": "operation",
  "experimental": false,
  "date": "2023-03-26T15:21:02+11:00",
  "publisher": "TEHIK",
  "contact": [
    {
      "name": "TEHIK",
      "telecom": [
        {
          "system": "url",
          "value": "https://tehik.ee"
        }
      ]
    }
  ],
  "description": "The link operation is used to link two patient resources. One of the two patients is identified as the source and one as the target. The link with type 'replaces' created from source to destination patient, the another link with type 'replaced-byä created from destination to source patient. As result of linking the destination patient is deactivated.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "EE",
          "display": "Estonia"
        }
      ]
    }
  ],
  "affectsState": true,
  "code": "link",
  "resource": [
    "Patient"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "source-patient",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A direct resource reference to the **source** patient resource (this may include an identifier).",
      "type": "Reference",
      "targetProfile": [
        "http://hl7.org/fhir/StructureDefinition/Patient"
      ]
    },
    {
      "name": "source-patient-identifier",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "When source-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the source patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as part of a review by a user.",
      "type": "Identifier"
    },
    {
      "name": "target-patient",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A direct resource reference to the **target** patient resource.\r\rThis is the surviving patient resource, the target for the link.",
      "type": "Reference",
      "targetProfile": [
        "http://hl7.org/fhir/StructureDefinition/Patient"
      ]
    },
    {
      "name": "target-patient-identifier",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "When target-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the target patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as part of a review by a user.",
      "type": "Identifier"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The status of the response will be one of:\r\r* 200 OK - If the merge request doesn't expect any issues (although warning may be present) for a preview, or was completed without issues if not a preview\r* 202 Accepted - The merge request has been accepted and does not expect any issues and will continue processing the merge in the background, and you can monitor the Task for completion\r* 400 Bad Request - There are errors in the input parameters that need to corrected\r* 422 Unprocessable Entity - Business rules prevent this merge from completing\r\rThe Parameters resource will include:\r\r* The Input parameters to the operation\r* An OperationOutcome containing errors, warnings, and information messages\r* The resulting merged Patient resource (or a patient reference if the patient is not committed)\r* Optionally a Task resource to track any additional processing that was required.",
      "type": "Patient"
    }
  ]
}