Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Operation: documentReference-generate

Generate a CDA or other standards based document from resource data associated with the patient referenced by patient parameter below.

GET [base]/$generate?{operation-parameters}

Where:

Use Name Cardinality Type Binding Documentation
IN patient 0..1 reference A reference to the patient for whom the document will be generated. The document will include data from this patient's record. Patient can be omitted when the patient for whom the document is being generated can be inferred from other parameters.
IN type 0..1 token Document Type Value Set (Preferred ) The type of document to be generated.
IN class 0..1 token Document Class Value Set (Preferred ) The document class to be generated.
IN format 0..* token Document Format Value Set (Preferred ) The format to be used when generating the document.
IN contentType 0..1 token MimeType (Required ) The contentType of the document to be generated.
IN author 0..* reference The author of the document. Must be a legal reference to a Patient or Practitioner known to the current system.
IN authenticator 0..1 reference The legal authenticator of the document. Must be a legal reference to a Patient or Practitioner known to the current system.
IN encounter 0..1 reference The encounter associated with the document. Must be a legal reference to an Encounter known to the current system.
IN order 0..1 reference The referral or test order to be used when generating documents where class indicates a Transition of Care.
IN fromDate 0..1 date Start date of the time period associated with the data elements.
IN toDate 0..1 date End date of the time period associated with the data elements.
IN description 0..1 string A description to include within the DocumentReference returned by this operation.
IN exclusions 0..* uri URIs identifing resources to exclude from the document.
IN persist 0..1 boolean If true, the generated document will be persisted. The default if not specified is false.
IN securityLabel 0..* token Security tags to be associated with this docment.
IN raw 0..1 boolean true | false
OUT return 1..1 DocumentReference | Binary A populated DocumentReference or Binary resource containing metadata about the document and the body of the document in the content attachment (when raw=false or is omitted), or just the body of the document (when raw=true).