medTech IG
0.1.0 - CI Build

medTech IG, published by medtech. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7NZ/medtech/ and changes regularly. See the Directory of published versions

Example OperationDefinition: summary

PatientSummary

OPERATION: PatientSummary

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/Patient-summary

The summary operation asks the server to return the latest appropriate summary for the patient. The patient is either

  • explicitly identified by the id of the patient resource
  • implicitly identified as the only patient in scope due to security/context
  • specified by other additional (unspecified here) parameters (or do we specify the identifier parameter?)

This operation returns a bundle (type = document) for single patient.

The operation asks for the latest appropriate summary, whether that already exists, or must be newly generated. Unless otherwise specified, the server has discretion to choose how to fulfill the request. We anticipate that there will be a profusion of business practices around currency/attestation, and therefore variance in parameters around that. If some consistency emerges, HL7 would consider adding additional parameters to the base definition

URL: [base]/Patient/$summary

URL: [base]/Patient/[id]/$summary

Parameters

UseNameCardinalityTypeBindingDocumentation
INidentifier0..1Identifier

The identifier of the patient which is the target. Used when the operation is invoked against the Patient type, ignored if invoked against a Patient instance

INprofile0..1uri
INgraph0..1uri

Used when the url for a GraphDefinition resource is passed in that explicitely defines the contents of the bundle returned.

This Operation Definition is proposed as an HL7 one, based on the needs of this (and other) Implementation Guides We anticipate that there will be a profusion of business practices around currency/attestation, and therefore variance in parameters around that. If some consistency emerges, HL7 would consider adding additional parameters to the base definition

IPS will define a profile on Bundle with the URL in the example above, so that an IPS can be reqested. In the absence of a profile parameter, server has discretion to construct/return a summary of it's choice