Operation-documentreference-docref

Release 5

Publish-box (todo)

Example OperationDefinition/DocumentReference-docref (Narrative)

Orders and Observations Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

This is the narrative for the resource. See also the XML, JSON or Turtle format.

Note that this is the formal definition for the docref operation as an OperationDefinition on DocumentReference. See the Operation documentation

URL: [base]/DocumentReference/$docref

Parameters

Use

Name

Scope

Cardinality

Type

Binding

Documentation

IN

patient

1..1

id

The id of the patient resource located on the server on which this operation is executed. If there is no match, an empty Bundle is returned

IN

start

0..1

dateTime

The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all documents prior to the end date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset.

IN

end

0..1

dateTime

The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all documents subsequent to the start date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset.

IN

type

0..1

CodeableConcept

FHIR Document Type Codes (Required)

The type relates to document type e.g. for the LOINC code for a C-CDA Clinical Summary of Care (CCD) is 34133-9 (Summary of episode note). If no type is provided, the CCD document, if available, SHALL be in scope and all other document types MAY be in scope

IN

on-demand

0..1

boolean

This on-demand parameter allows client to dictate whether they are requesting only 'on-demand' or both 'on-demand' and 'stable' documents (or delayed/deferred assembly) that meet the query parameters

OUT

return

1..1

Bundle

The bundle type is "searchset"containing DocumentReference resources.

The server either returns a search result containing a single DocumentReference, or it returns an error.

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.