Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Example OperationDefinition/Composition-document (Narrative)

Structured Documents 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 document operation as an OperationDefinition on Composition. See the Operation documentation

URL: [base]/Composition/$document

URL: [base]/Composition/[id]/$document

Parameters

UseNameCardinalityTypeBindingDocumentation
INid0..1uri

Identifies the composition to use. This can either be a simple id, which identifies a composition, or it can be a full URL, which identifies a composition on another server.

Notes:

  • GET [base]/Composition/[id]/$document is identical in meaning to GET [base]/Composition/$document?id=[id]
  • the id parameter SHALL NOT be used if the operation is requested on a particular composition (e.g. GET [base]/Composition/[id]/$document?id=[id] is not allowed)
  • Servers are not required to support generating documents on Compositions located on another server
INpersist0..1boolean

Whether to store the document at the bundle end-point (/Bundle) or not once it is generated. Value = true or false (default is for the server to decide). If the document is stored, it's location can be inferred from the Bundle.id, but it SHOULD be provided explicitly in the HTTP Location header in the response

INgraph0..1uri

Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources

Notes:

  • The server implementing the operation SHOULD determine a 'high-level water-mark' for the document security tags (Bundle.meta.security)) as a whole, based on an analysis of the resources contained within the document
  • this operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question

 

 

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.