HDR FHIR API

Root Schema : ExampleScenario

Type: object

Show Source

actor: array actor

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
instance: array instance

Minimum Number of Items: 1

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

Minimum Number of Items: 1

Unique Items Required: true
purpose: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "actor",
        "id",
        "instance",
        "meta",
        "process",
        "purpose",
        "resourceType",
        "status",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "purpose":{
            "type":"string",
            "minLength":1
        },
        "actor":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ExampleScenario_actor"
            },
            "minItems":1
        },
        "instance":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ExampleScenario_instance"
            },
            "minItems":1
        },
        "process":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ExampleScenario_process"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : actor

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ExampleScenario_actor

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

Nested Schema : instance

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ExampleScenario_instance

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ExampleScenario_process

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

Type: object

Show Source

actorId: string

Minimum Length: 1
description: string

Minimum Length: 1
name: string

Minimum Length: 1
type: string

Minimum Length: 1

{
    "required":[
        "actorId",
        "description",
        "name",
        "type"
    ],
    "properties":{
        "actorId":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ExampleScenario_instance

Type: object

Show Source

containedInstance(optional): array containedInstance

Minimum Number of Items: 1

Unique Items Required: true
description: string

Minimum Length: 1
name: string

Minimum Length: 1
resourceId: string

Minimum Length: 1
resourceType: string

Minimum Length: 1

{
    "required":[
        "description",
        "name",
        "resourceId",
        "resourceType"
    ],
    "properties":{
        "resourceId":{
            "type":"string",
            "minLength":1
        },
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "containedInstance":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ExampleScenario_containedInstance"
            },
            "minItems":1
        }
    }
}

Nested Schema : containedInstance

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ExampleScenario_containedInstance

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

Nested Schema : ExampleScenario_containedInstance

Type: object

Show Source

resourceId: string

Minimum Length: 1

{
    "required":[
        "resourceId"
    ],
    "properties":{
        "resourceId":{
            "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
        }
    }
}

Nested Schema : ExampleScenario_process

Type: object

Show Source

description: string

Minimum Length: 1
postConditions: string

Minimum Length: 1
preConditions: string

Minimum Length: 1
step(optional): array step

Minimum Number of Items: 1

Unique Items Required: true
title: string

Minimum Length: 1

{
    "required":[
        "description",
        "postConditions",
        "preConditions",
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "preConditions":{
            "type":"string",
            "minLength":1
        },
        "postConditions":{
            "type":"string",
            "minLength":1
        },
        "step":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ExampleScenario_step"
            },
            "minItems":1
        }
    }
}

Nested Schema : step

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ExampleScenario_step

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

Nested Schema : ExampleScenario_step

Type: object

Show Source

operation(optional): object ExampleScenario_operation

{
    "properties":{
        "operation":{
            "$ref":"#/definitions/ExampleScenario_operation"
        }
    }
}

Nested Schema : ExampleScenario_operation

Type: object

Show Source

initiator: string

Minimum Length: 1
name: string

Minimum Length: 1
number: string

Minimum Length: 1
receiver: string

Minimum Length: 1

{
    "required":[
        "initiator",
        "name",
        "number",
        "receiver"
    ],
    "properties":{
        "number":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "initiator":{
            "type":"string",
            "minLength":1
        },
        "receiver":{
            "type":"string",
            "minLength":1
        }
    }
}

GET ExampleScenario Resource by ID

Request

Response

200 Response