HDR FHIR API

Root Schema : VisionPrescription

Type: object

Show Source

created: string

Minimum Length: 1
dateWritten: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
lensSpecification: array lensSpecification

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
patient: object Account_coverage
prescriber: object Account_coverage
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "created",
        "dateWritten",
        "id",
        "identifier",
        "lensSpecification",
        "meta",
        "patient",
        "prescriber",
        "resourceType",
        "status",
        "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/Account_identifier"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "created":{
            "type":"string",
            "minLength":1
        },
        "patient":{
            "$ref":"#/definitions/Account_coverage"
        },
        "dateWritten":{
            "type":"string",
            "minLength":1
        },
        "prescriber":{
            "$ref":"#/definitions/Account_coverage"
        },
        "lensSpecification":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/VisionPrescription_lensSpecification"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object VisionPrescription_lensSpecification

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

Type: object

Show Source

reference: string

Minimum Length: 1

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

Type: object

Show Source

add: number
axis: number
cylinder: number
eye: string

Minimum Length: 1
prism(optional): array prism

Minimum Number of Items: 1

Unique Items Required: true
product(optional): object Basic_code
sphere: number

{
    "required":[
        "add",
        "axis",
        "cylinder",
        "eye",
        "sphere"
    ],
    "properties":{
        "product":{
            "$ref":"#/definitions/Basic_code"
        },
        "eye":{
            "type":"string",
            "minLength":1
        },
        "sphere":{
            "type":"number"
        },
        "cylinder":{
            "type":"number"
        },
        "axis":{
            "type":"number"
        },
        "prism":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/VisionPrescription_prism"
            },
            "minItems":1
        },
        "add":{
            "type":"number"
        }
    }
}

Nested Schema : prism

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object VisionPrescription_prism

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

Nested Schema : Basic_code

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : VisionPrescription_prism

Type: object

Show Source

amount: number
base: string

Minimum Length: 1

{
    "required":[
        "amount",
        "base"
    ],
    "properties":{
        "amount":{
            "type":"number"
        },
        "base":{
            "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 : 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
        }
    }
}

Update VisionPrescription Resource

Request

Response

200 Response