Home
API reference
FHIR® API
FHIR® resources
DocumentReference
read

DocumentReference read

get/DocumentReference/{id}
Page View

This resource contains metadata for any kind of document so that you can locate the document in a system. You can typically use this as a reference in another resource type that includes the subject, author, and context for a related document. 

You may want to use this resource if (a) you want raw XML data or (b) you want you to pick what documents to view or retrieve. If you’re familiar with our Redox data models, this is the FHIR® representation of the ClinicalSummary.DocumentGet. Learn more about the DocumentGet event type. Or, if you only want to retrieve the patient’s latest CDA, check out the PatientQuery event type.

You can receive, retrieve, or save document references.

read

This interaction allows you to review metadata for a related document for a given context, whether for a patient, visit, or other clinical concept.

Request parameters

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/DocumentReference/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

  • id
    required, string

    DocumentReference identifier

Response fields and example

Example payload generated from schema

1
{
2
  "resourceType": "DocumentReference",
3
  "id": "string",
4
  "masterIdentifier": {
5
    "extension": [
6
      {
7
        "url": "string",
8
        "valueBoolean": true
9
      }
10
    ],
11
    "use": "usual",
12
    "system": "string",
13
    "value": "string"
14
  },
15
  "status": "current",
16
  "type": {
17
    "coding": [
18
      {
19
        "system": "string",
20
        "code": "string"
21
      }
22
    ],
23
    "text": "string"
24
  },
25
  "category": [
26
    {
27
      "coding": [
28
        {
29
          "code": "string",
30
          "system": "string"
31
        }
32
      ],
33
      "text": "string"
34
    }
35
  ],
36
  "subject": {
37
    "reference": "string"
38
  },
39
  "date": "string",
40
  "author": [
41
    {
42
      "reference": "string"
43
    }
44
  ],
45
  "authenticator": {
46
    "reference": "string"
47
  },
48
  "relatesTo": [
49
    {
50
      "code": "replaces",
51
      "target": {
52
        "extension": [
53
          {
54
            "url": "http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber",
55
            "valueInteger": 0
56
          }
57
        ],
58
        "identifier": {
59
          "extension": [
60
            {
61
              "url": "string",
62
              "valueBoolean": true
63
            }
64
          ],
65
          "use": "usual",
66
          "system": "string",
67
          "value": "string"
68
        }
69
      }
70
    }
71
  ],
72
  "description": "string",
73
  "content": [
74
    {
75
      "attachment": {
76
        "contentType": "text/xml",
77
        "data": "string"
78
      }
79
    }
80
  ],
81
  "context": {
82
    "encounter": [
83
      {
84
        "identifier": {
85
          "extension": [
86
            {
87
              "url": "string",
88
              "valueBoolean": true
89
            }
90
          ],
91
          "use": "usual",
92
          "system": "string",
93
          "value": "string"
94
        }
95
      }
96
    ],
97
    "period": {
98
      "start": "string",
99
      "end": "string"
100
    }
101
  }
102
}

    Documents stored in Redox

  • resourceType
    required, string

    Identifies the type of the resource

    Value: DocumentReference
  • status
    required, string

    The status of this document reference.

    Possible Values: current, superseded, entered-in-error
  • category
    required, Array of object

    A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

    • coding
      Array of object

      A reference to a code defined by a terminology system.

      • system
        required, string

        The identification of the code system that defines the meaning of the symbol in the code.

        Value: urn:redox:document_kind
      • code
        required, string

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        Value: CDA
    • text
      string

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

  • content
    required, Array of object

    The document and format referenced. There may be multiple content element repetitions, each with a different format.

    • attachment
      required, object

      The document or URL of the document along with critical metadata to prove content has integrity.

      • contentType
        string

        Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

        Value: text/xml
      • data
        string

        The actual data of the attachment - a sequence of bytes, base64 encoded.

  • id
    string

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

  • masterIdentifier
    object

    Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

    • extension
      Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • url
        required, string

        Source of the definition for the extension code - a logical name or a URL.

      • valueBoolean
        boolean

        A single value for the extension.

    • use
      string

      The purpose of this identifier.

      Possible Values: usual, official, temp, secondary, old (If known)
    • system
      string

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    • value
      string

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

  • type
    object

    Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

    • coding
      Array of object

      A reference to a code defined by a terminology system.

      • system
        string

        The identification of the code system that defines the meaning of the symbol in the code.

      • code
        string

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    • text
      string

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

  • subject
    object

    Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

    Must reference one of the following types of resources:

    • Patient
    • Practitioner
    • Group
    • Device
    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • date
    string

    When the document reference was created.

  • author
    Array of object

    Identifies who is responsible for adding the information to the document.

    Must reference one of the following types of resources:

    • Practitioner
    • PractitionerRole
    • Organization
    • Device
    • Patient
    • RelatedPerson
    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • authenticator
    object

    Which person or organization authenticates that this document is valid.

    Must reference one of the following types of resources:

    • Practitioner
    • PractitionerRole
    • Organization
    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • relatesTo
    Array of object

    Relationships that this document has with other document references that already exist.

    • code
      required, string

      The type of relationship that this document has with anther document.

      Possible Values: replaces, transforms, signs, appends
    • target
      required, object

      The target document of this relationship.

      Must be a resource of type DocumentReference.

      • extension
        Array of object

        Additional information about the related document

        • url
          required, string

          Source of the definition for the extension code - a logical name or a URL.

          Value: http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber
        • valueInteger
          number

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • identifier
        object

        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

          • valueBoolean
            boolean

            A single value for the extension.

        • use
          string

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old (If known)
        • system
          string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

  • description
    string

    Human-readable description of the source document.

  • context
    object

    The clinical context in which the document was prepared.

    • encounter
      Array of object

      Describes the clinical encounter or type of care that the document content is associated with.

      Must reference one of the following types of resources:

      • Encounter
      • EpisodeOfCare
      • identifier
        object

        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

          • valueBoolean
            boolean

            A single value for the extension.

        • use
          string

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old (If known)
        • system
          string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    • period
      object

      The time period over which the service that is described by the document was provided.

      • start
        string

        The start of the period. The boundary is inclusive.

      • end
        string

        The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.