HDR FHIR API

GET Communication Resource Bundle

get

/oracle-fhir-server/fhir/Communication

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
based-on(optional): string

Request fulfilled by this communication
category(optional): string

Message category
encounter(optional): string

Encounter created as part of
identifier(optional): string

Unique identifier
instantiates-canonical(optional): string

Instantiates FHIR protocol or definition
instantiates-uri(optional): string

Instantiates external protocol or definition
medium(optional): string

A channel of communication
part-of(optional): string

Part of this action
patient(optional): string

Focus of message
received(optional): string(date)

When received
recipient(optional): string

Message recipient
sender(optional): string

Message sender
sent(optional): string(date)

When sent
status(optional): string

preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
subject(optional): string

Focus of message

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Communication

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

Nested Schema : Communication

Type: object

Show Source

category: array category

Minimum Number of Items: 1

Unique Items Required: true
encounter: object Account_coverage
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
instantiatesUri: array instantiatesUri
medium: array medium

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
partOf: array partOf

Minimum Number of Items: 1

Unique Items Required: true
payload: array payload

Minimum Number of Items: 1

Unique Items Required: true
received: string

Minimum Length: 1
recipient: array recipient

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
sender: object Account_coverage
sent: string

Minimum Length: 1
status: string

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

{
    "type":"object",
    "required":[
        "category",
        "encounter",
        "id",
        "identifier",
        "instantiatesUri",
        "medium",
        "meta",
        "partOf",
        "payload",
        "received",
        "recipient",
        "resourceType",
        "sender",
        "sent",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Communication_identifier"
            },
            "minItems":1
        },
        "instantiatesUri":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "partOf":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_source_observer"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "category":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Communication_category"
            },
            "minItems":1
        },
        "medium":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Communication_medium"
            },
            "minItems":1
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "encounter":{
            "$ref":"#/definitions/Account_coverage"
        },
        "sent":{
            "type":"string",
            "minLength":1
        },
        "received":{
            "type":"string",
            "minLength":1
        },
        "recipient":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "sender":{
            "$ref":"#/definitions/Account_coverage"
        },
        "payload":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Communication_payload"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : category

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Communication_category

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

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Communication_identifier

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

Nested Schema : instantiatesUri

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : medium

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Communication_medium

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Communication_medium"
    },
    "minItems":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 : partOf

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_source_observer

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

Nested Schema : payload

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Communication_payload

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

Nested Schema : recipient

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_coverage"
    },
    "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 : Communication_category

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true
text: string

Minimum Length: 1

{
    "required":[
        "text"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_code"
            },
            "minItems":1
        },
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

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

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

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

Nested Schema : Communication_identifier

Type: object

Show Source

system: string

Minimum Length: 1
type(optional): object ActivityDefinition_topic
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "type":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

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

Nested Schema : items

Type: object

Show Source

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

Nested Schema : Communication_medium

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true
text: string

Minimum Length: 1

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

Nested Schema : coding

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
        }
    }
}

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 : AuditEvent_source_observer

Type: object

Show Source

display: string

Minimum Length: 1

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

Nested Schema : Communication_payload

Type: object

Show Source

contentString: string

Minimum Length: 1

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