Jump to

• Request
• Response

Get a list of document references

get

/DocumentReference

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of document references that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• category: string
  A categorization for the type of document referenced.
• date: string
  When the document reference was created.
• patient: string
  Who or what the document is about.
• type: string
  The type of document referenced.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/DocumentReference"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/DocumentReference"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object DocumentReference
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/DocumentReference"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : DocumentReference

Type: object

Show Source

• author: array author
  The individual who is responsible for adding the information to the document.
• category(required): array category
  A categorization for the type of document referenced.
• content(required): array content
  The document and format referenced.
• context: context
  The clinical context in which the document was prepared.
• date: string (date-time)
  When the document reference was created.
• id(required): string
• identifier: array identifier
  The other identifiers associated with the document, including version-independent identifiers.
• resourceType(required): string
  Allowed Values: [ "DocumentReference" ]
• status(required): string
  The status of this document reference.
• subject(required): subject
  Who or what the document is about.
• type(required): type
  The particular type of document referenced.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "type",
        "category",
        "subject",
        "content"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "DocumentReference"
            ]
        },
        "id":{
            "type":"string"
        },
        "identifier":{
            "type":"array",
            "description":"The other identifiers associated with the document, including version-independent identifiers.",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "status":{
            "type":"string",
            "description":"The status of this document reference."
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"The particular type of document referenced."
        },
        "category":{
            "type":"array",
            "description":"A categorization for the type of document referenced.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"Who or what the document is about."
        },
        "date":{
            "type":"string",
            "format":"date-time",
            "description":"When the document reference was created."
        },
        "author":{
            "type":"array",
            "description":"The individual who is responsible for adding the information to the document.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "content":{
            "type":"array",
            "description":"The document and format referenced.",
            "items":{
                "$ref":"#/components/schemas/DocumentReferenceContent"
            }
        },
        "context":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DocumentReferenceContext"
                }
            ],
            "description":"The clinical context in which the document was prepared."
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : author

Type: array

The individual who is responsible for adding the information to the document.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"The individual who is responsible for adding the information to the document.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : category

Type: array

A categorization for the type of document referenced.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"A categorization for the type of document referenced.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : content

Type: array

The document and format referenced.

Show Source

• Array of: object DocumentReferenceContent

{
    "type":"array",
    "description":"The document and format referenced.",
    "items":{
        "$ref":"#/components/schemas/DocumentReferenceContent"
    }
}

Nested Schema : context

The clinical context in which the document was prepared.

Match All

The clinical context in which the document was prepared.

Show Source

• object DocumentReferenceContext

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DocumentReferenceContext"
        }
    ],
    "description":"The clinical context in which the document was prepared."
}

Nested Schema : identifier

Type: array

The other identifiers associated with the document, including version-independent identifiers.

Show Source

• Array of: object Identifier

{
    "type":"array",
    "description":"The other identifiers associated with the document, including version-independent identifiers.",
    "items":{
        "$ref":"#/components/schemas/Identifier"
    }
}

Nested Schema : subject

Who or what the document is about.

Match All

Who or what the document is about.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"Who or what the document is about."
}

Nested Schema : type

The particular type of document referenced.

Match All

The particular type of document referenced.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"The particular type of document referenced."
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : DocumentReferenceContent

Type: object

Show Source

• attachment(required): attachment
  The document or URL of the document with critical metadata to prove that the content has integrity.
• format: format
  An identifier of the document encoding, structure, and template.

{
    "type":"object",
    "required":[
        "attachment"
    ],
    "properties":{
        "attachment":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DocumentReferenceAttachment"
                }
            ],
            "description":"The document or URL of the document with critical metadata to prove that the content has integrity."
        },
        "format":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Coding"
                }
            ],
            "description":"An identifier of the document encoding, structure, and template."
        }
    }
}

Nested Schema : attachment

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

Match All

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

Show Source

• object DocumentReferenceAttachment

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DocumentReferenceAttachment"
        }
    ],
    "description":"The document or URL of the document with critical metadata to prove that the content has integrity."
}

Nested Schema : format

An identifier of the document encoding, structure, and template.

Match All

An identifier of the document encoding, structure, and template.

Show Source

• object Coding

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Coding"
        }
    ],
    "description":"An identifier of the document encoding, structure, and template."
}

Nested Schema : DocumentReferenceAttachment

Type: object

Show Source

• contentType: string
  The type of data in the attachment that allows a method to be chosen to interpret or render the data.
• data: string
  The actual data of the attachment, which is base64 encoded.
• url: string (uri)
  A location where the data can be accessed.

{
    "type":"object",
    "properties":{
        "contentType":{
            "type":"string",
            "description":"The type of data in the attachment that allows a method to be chosen to interpret or render the data."
        },
        "data":{
            "type":"string",
            "description":"The actual data of the attachment, which is base64 encoded."
        },
        "url":{
            "type":"string",
            "format":"uri",
            "description":"A location where the data can be accessed."
        }
    }
}

Nested Schema : DocumentReferenceContext

Type: object

Show Source

• encounter: encounter
  The clinical encounter that the document content is associated with.
• period: period
  The time period over which the service that is described by the document was provided.

{
    "type":"object",
    "properties":{
        "encounter":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"The clinical encounter that the document content is associated with."
        },
        "period":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Period"
                }
            ],
            "description":"The time period over which the service that is described by the document was provided."
        }
    }
}

Nested Schema : encounter

The clinical encounter that the document content is associated with.

Match All

The clinical encounter that the document content is associated with.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"The clinical encounter that the document content is associated with."
}

Nested Schema : period

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

Match All

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

Show Source

• object Period

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Period"
        }
    ],
    "description":"The time period over which the service that is described by the document was provided."
}

Nested Schema : Period

Type: object

Show Source

• end: string (date-time)
• start: string (date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : Identifier

Type: object

Show Source

• system(required): string (uri)
• value(required): string

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top