HDR FHIR API

GET CommunicationRequest Resource Bundle

get

/oracle-fhir-server/fhir/CommunicationRequest

This endpoint supports the retrieval of CommunicationRequest resource list.It returns Bundle of CommunicationRequest resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
authored(optional): string(date)

When request transitioned to being actionable
based-on(optional): string

Fulfills plan or proposal
category(optional): string

Message category
encounter(optional): string

Encounter created as part of
group-identifier(optional): string

Composite request this is part of
identifier(optional): string

Unique identifier
medium(optional): string

A channel of communication
occurrence(optional): string(date)

When scheduled
patient(optional): string

Focus of message
priority(optional): string

Message urgency
recipient(optional): string

Message recipient
replaces(optional): string

Request(s) replaced by this request
requester(optional): string

Who/what is requesting service
sender(optional): string

Message sender
status(optional): string

draft | active | suspended | cancelled | completed | entered-in-error | unknown
subject(optional): string

Focus of message

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object CommunicationRequest

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CommunicationRequest"
    }
}

Nested Schema : CommunicationRequest

Type: object

Show Source

encounter: object Account_coverage
id: string

Minimum Length: 1
meta: object Account_meta
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subject: object Account_coverage
text: object Account_text

{
    "type":"object",
    "required":[
        "encounter",
        "id",
        "meta",
        "resourceType",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "encounter":{
            "$ref":"#/definitions/Account_coverage"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}