HDR FHIR API

GET MessageDefinition Resource Bundle

get

/oracle-fhir-server/fhir/MessageDefinition

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
category(optional): string

The behavior associated with the message
context(optional): string

A use context assigned to the message definition
context-quantity(optional): integer

A quantity- or range-valued use context assigned to the message definition
context-type(optional): string

A type of use context assigned to the message definition
context-type-quantity(optional): string

A use context type and quantity- or range-based value assigned to the message definition
context-type-value(optional): string

A use context type and value assigned to the message definition
date(optional): string(date)

The message definition publication date
description(optional): string

The description of the message definition
event(optional): string

The event that triggers the message or link to the event definition.
focus(optional): string

A resource that is a permitted focus of the message
identifier(optional): string

External identifier for the message definition
jurisdiction(optional): string

Intended jurisdiction for the message definition
name(optional): string

Computationally friendly name of the message definition
parent(optional): string

A resource that is the parent of the definition
publisher(optional): string

Name of the publisher of the message definition
status(optional): string

The current status of the message definition
title(optional): string

The human-friendly name of the message definition
url(optional): string

The uri that identifies the message definition
version(optional): string

The business version of the message definition

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object MessageDefinition

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

Nested Schema : MessageDefinition

Type: object

Show Source

category: string

Minimum Length: 1
contact: array contact

Minimum Number of Items: 1

Unique Items Required: true
date: string

Minimum Length: 1
eventCoding: object ActivityDefinition_code
experimental: boolean
id: string

Minimum Length: 1
name: string

Minimum Length: 1
publisher: string

Minimum Length: 1
purpose: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text
title: string

Minimum Length: 1
url: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "category",
        "contact",
        "date",
        "eventCoding",
        "experimental",
        "id",
        "name",
        "publisher",
        "purpose",
        "resourceType",
        "status",
        "text",
        "title",
        "url"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "url":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "experimental":{
            "type":"boolean"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "publisher":{
            "type":"string",
            "minLength":1
        },
        "contact":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/GraphDefinition_contact"
            },
            "minItems":1
        },
        "purpose":{
            "type":"string",
            "minLength":1
        },
        "eventCoding":{
            "$ref":"#/definitions/ActivityDefinition_code"
        },
        "category":{
            "type":"string",
            "minLength":1
        }
    },
    "description":""
}

Nested Schema : contact

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object GraphDefinition_contact

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

Type: object

Show Source

telecom(optional): array telecom

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : telecom

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_identifier

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

Nested Schema : Account_identifier

Type: object

Show Source

system: string

Minimum Length: 1
value: string

Minimum Length: 1

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