HDR FHIR API

Root Schema : GuidanceResponse

Type: object

Show Source

contained: array contained

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
meta: object Account_meta
moduleUri: string

Minimum Length: 1
occurrenceDateTime: string

Minimum Length: 1
outputParameters: object Account_coverage
performer: object Account_coverage
reasonCode: array reasonCode

Minimum Number of Items: 1

Unique Items Required: true
requestIdentifier: object Account_identifier
resourceType: string

Minimum Length: 1
status: string

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

{
    "type":"object",
    "required":[
        "contained",
        "encounter",
        "id",
        "identifier",
        "meta",
        "moduleUri",
        "occurrenceDateTime",
        "outputParameters",
        "performer",
        "reasonCode",
        "requestIdentifier",
        "resourceType",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "contained":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/GuidanceResponse_contained"
            },
            "minItems":1
        },
        "requestIdentifier":{
            "$ref":"#/definitions/Account_identifier"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "moduleUri":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "encounter":{
            "$ref":"#/definitions/Account_coverage"
        },
        "occurrenceDateTime":{
            "type":"string",
            "minLength":1
        },
        "performer":{
            "$ref":"#/definitions/Account_coverage"
        },
        "reasonCode":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "outputParameters":{
            "$ref":"#/definitions/Account_coverage"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : contained

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object GuidanceResponse_contained

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

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

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

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

Type: object

Show Source

id: string

Minimum Length: 1
parameter(optional): array parameter

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1

{
    "required":[
        "id",
        "resourceType"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "parameter":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/GuidanceResponse_parameter"
            },
            "minItems":1
        }
    }
}

Nested Schema : parameter

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object GuidanceResponse_parameter

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

Nested Schema : GuidanceResponse_parameter

Type: object

Show Source

name: string

Minimum Length: 1
valueDecimal: number

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

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

Type: object

Show Source

text: string

Minimum Length: 1

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

Update GuidanceResponse Resource

Request

Response

200 Response