Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Operation-documentreference-generate

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.

generate

OPERATION: generate

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/DocumentReference-generate

A client can ask a server to generate a document reference from a document. The server reads the existing document and generates a matching DocumentReference resource, or returns one it has previously generated. Servers may be able to return or generate document references for the following types of content:

URL: [base]/DocumentReference/$generate

Parameters

Use

Name

Cardinality

Type

Binding

Documentation

IN

url

1..1

uri

IN

persist

0..1

Binary

Whether to store the document at the document end-point (/Document) or not, once it is generated (default is for the server to decide).

OUT

docRef

0..1

DocumentReference

The server either returns a single document reference, or it returns an error. If the input url refers to another server, it is at the discretion of the server whether to retrieve it or return an error.

The server either returns a search result containing a single document reference, or it returns an error. If the URI refers to another server, it is at the discretion of the server whether to retrieve it or return 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.