FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example OperationDefinition/DocumentReference-generate (Narrative)

Orders and Observations Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: 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 generate operation as an OperationDefinition on DocumentReference. See the Operation documentation


URL: [base]/DocumentReference/$generate

Parameters

UseNameCardinalityTypeBindingDocumentation
INurl1..1uri

The URL to the source document. This may be a general URL or a Binary or a Composition or a Bundle.

INpersist0..1boolean

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

OUTdocRef0..1DocumentReference

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.