Jump to

• Request
• Response

Generate an on-demand C-CDA document reference

post

/DocumentReference/$docref

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Returns a searchset Bundle containing a synthetic C-CDA document reference when the type is omitted or includes LOINC 34133-9.

Request

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

Supported Media Types

• application/fhir+json
• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• parameter(required): array parameter
• resourceType(required): string
  Allowed Values: [ "Parameters" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "parameter"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Parameters"
            ]
        },
        "parameter":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ParameterForDocumentReference"
            }
        }
    }
}

Nested Schema : parameter

Type: array

Show Source

• Array of: object ParameterForDocumentReference

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

Nested Schema : ParameterForDocumentReference

Type: object

Show Source

• name(required): string
  Allowed Values: [ "patient", "start", "end", "type" ]
• valueCoding: object Coding
• valueDateTime: string (date-time)
• valueId: string

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "patient",
                "start",
                "end",
                "type"
            ]
        },
        "valueId":{
            "type":"string"
        },
        "valueDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "valueCoding":{
            "$ref":"#/components/schemas/Coding"
        }
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Request Body - application/fhir+json ()

Root Schema : schema

Type: object

Show Source

• parameter(required): array parameter
• resourceType(required): string
  Allowed Values: [ "Parameters" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "parameter"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Parameters"
            ]
        },
        "parameter":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ParameterForDocumentReference"
            }
        }
    }
}

Nested Schema : parameter

Type: array

Show Source

• Array of: object ParameterForDocumentReference

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

Nested Schema : ParameterForDocumentReference

Type: object

Show Source

• name(required): string
  Allowed Values: [ "patient", "start", "end", "type" ]
• valueCoding: object Coding
• valueDateTime: string (date-time)
• valueId: string

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "patient",
                "start",
                "end",
                "type"
            ]
        },
        "valueId":{
            "type":"string"
        },
        "valueDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "valueCoding":{
            "$ref":"#/components/schemas/Coding"
        }
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/fhir+json
• application/json

200 Response

The searchset Bundle containing zero document references or one synthetic document reference.

Body ()

Root Schema : BundleForDocumentReference

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "searchset"
            ]
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleEntryForDocumentReference"
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object BundleEntryForDocumentReference

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

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

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

Nested Schema : BundleEntryForDocumentReference

Type: object

Show Source

• fullUrl: string (uri)
• resource: resource
• search: object BundleEntrySearch

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/DocumentReference"
                },
                {
                    "$ref":"#/components/schemas/ProvenanceForDocumentReference"
                },
                {
                    "$ref":"#/components/schemas/OperationOutcome"
                }
            ]
        },
        "search":{
            "$ref":"#/components/schemas/BundleEntrySearch"
        }
    }
}

Nested Schema : resource

Match One Schema

Show Source

• object DocumentReference
  The FHIR R4 DocumentReference resource returned by read, search, or $docref operations.
• object ProvenanceForDocumentReference
  Additional Properties Allowed: true
• object OperationOutcome
  The FHIR OperationOutcome.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/DocumentReference"
        },
        {
            "$ref":"#/components/schemas/ProvenanceForDocumentReference"
        },
        {
            "$ref":"#/components/schemas/OperationOutcome"
        }
    ]
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

• mode: string

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

Nested Schema : DocumentReference

Type: object

The FHIR R4 DocumentReference resource returned by read, search, or $docref operations.

Show Source

• author: array author
• category: array category
• content(required): array content
• context: object ContextForDocumentReference
• custodian: object ReferenceForDocumentReference
• date: string (date-time)
• docStatus: string
• id(required): string
• identifier: array identifier
• meta: object meta
• resourceType(required): string
  Allowed Values: [ "DocumentReference" ]
• status(required): string
• subject(required): object ReferenceForDocumentReference
• type(required): object CodeableConcept

{
    "type":"object",
    "description":"The FHIR R4 DocumentReference resource returned by read, search, or $docref operations.",
    "required":[
        "resourceType",
        "id",
        "status",
        "type",
        "subject",
        "content"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "DocumentReference"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "identifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "status":{
            "type":"string"
        },
        "docStatus":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForDocumentReference"
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "author":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForDocumentReference"
            }
        },
        "custodian":{
            "$ref":"#/components/schemas/ReferenceForDocumentReference"
        },
        "content":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentForDocumentReference"
            }
        },
        "context":{
            "$ref":"#/components/schemas/ContextForDocumentReference"
        }
    }
}

Nested Schema : ProvenanceForDocumentReference

Type: object

Additional Properties Allowed: true

Show Source

• resourceType: string
  Allowed Values: [ "Provenance" ]

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Provenance"
            ]
        }
    },
    "additionalProperties":true
}

Nested Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : author

Type: array

Show Source

• Array of: object ReferenceForDocumentReference

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

Nested Schema : category

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : content

Type: array

Show Source

• Array of: object ContentForDocumentReference

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

Nested Schema : ContextForDocumentReference

Type: object

Show Source

• encounter: array encounter
• period: object Period

{
    "type":"object",
    "properties":{
        "encounter":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForDocumentReference"
            }
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : ReferenceForDocumentReference

Type: object

Show Source

• display: string
• reference: string

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

Nested Schema : identifier

Type: array

Show Source

• Array of: object Identifier

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

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : ContentForDocumentReference

Type: object

Show Source

• attachment(required): object AttachmentForDocumentReference
• format: object Coding

{
    "type":"object",
    "required":[
        "attachment"
    ],
    "properties":{
        "attachment":{
            "$ref":"#/components/schemas/AttachmentForDocumentReference"
        },
        "format":{
            "$ref":"#/components/schemas/Coding"
        }
    }
}

Nested Schema : AttachmentForDocumentReference

Type: object

Show Source

• _url: object PrimitiveElement
• contentType: string
• url: string (uri)

{
    "type":"object",
    "properties":{
        "contentType":{
            "type":"string"
        },
        "url":{
            "type":"string",
            "format":"uri"
        },
        "_url":{
            "$ref":"#/components/schemas/PrimitiveElement"
        }
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : PrimitiveElement

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Extension"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

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

Nested Schema : Extension

Type: object

Show Source

• url: string (uri)
• valueCode: string

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : encounter

Type: array

Show Source

• Array of: object ReferenceForDocumentReference

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

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : Identifier

Type: object

Show Source

• period: object Period
• system: string
• type: object CodeableConcept
• use: string
• value: string

{
    "type":"object",
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "system":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

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

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]

  The link relation.
• url: string
  The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

Default Response

OperationOutcome.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top