Document

A document is a supplemental object that provides additional context based on the content included in the resources. It is intended for use by consumers to generate a clinical document. The values for a document are statically defined and utilized by the specification. A document is any standardized aggregation of related content. For example, orders can be considered an 'order form'. Any synonym of document, such as form, questionnaire, file, or record, should be considered a document as well. The 'content' field of a document object should only be used for letters or documents where there's no need to provide a structured format. The 'content' field should not be used for structured data, such as orders, observations, or other resources that can be represented in a structured format.

Document example

{
  "document_status": "preliminary",
  "report_locale": "en-US",
  "document_title": "Referral Letter",
  "document_type": { 
    "text": "Referral Letter",
    "codes": [
      {
        "system": "LOINC",
        "system_oid": "2.16.840.1.113883.6.1",
        "identifier": "96349-6"                                  
      }
    ]
  },    
  "content": "To whom it may concern, \n Please take Mrs. Jones as a patient. \n Sincerely, Dr. Pepper"
}

Document schema properties

Property Type Description Notes
document_status string The status of the document at the time the payload/feedback was provided. proposed, preliminary, in_progress, final_unsigned, final_signed, amended_unsigned, amended_signed, cancelled, deprecated
report_locale string The locale of language used in the report. This is a combination of the language and country code. For example: en-US, en-GB, fr-FR, fr-CA, es-MX, es-ES.
document_title string The title of the document.
document_type object The type of document, including a title and coding standards. See below for details.
content string The content of the document, which is the complete text content of the document. Must only be used when there is no need for a structured representation of document content.

document_type object

Property Type Description
text string The title of the document_type.
codes array See code definition.
  • Last updated on