HDR FHIR API

Root Schema : ImagingStudy

Type: object

Show Source

id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
numberOfInstances: number
numberOfSeries: number
resourceType: string

Minimum Length: 1
series: array series

Minimum Number of Items: 1

Unique Items Required: true
started: string

Minimum Length: 1
status: string

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

{
    "type":"object",
    "required":[
        "id",
        "identifier",
        "meta",
        "numberOfInstances",
        "numberOfSeries",
        "resourceType",
        "series",
        "started",
        "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/Account_identifier"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "started":{
            "type":"string",
            "minLength":1
        },
        "numberOfSeries":{
            "type":"number"
        },
        "numberOfInstances":{
            "type":"number"
        },
        "series":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImagingStudy_series"
            },
            "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 : 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 : series

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImagingStudy_series

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

Type: object

Show Source

bodySite(optional): object Account_type_coding
description: string

Minimum Length: 1
instance(optional): array instance

Minimum Number of Items: 1

Unique Items Required: true
modality(optional): object ActivityDefinition_code
number: number
numberOfInstances: number
uid: string

Minimum Length: 1

{
    "required":[
        "description",
        "number",
        "numberOfInstances",
        "uid"
    ],
    "properties":{
        "uid":{
            "type":"string",
            "minLength":1
        },
        "number":{
            "type":"number"
        },
        "modality":{
            "$ref":"#/definitions/ActivityDefinition_code"
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "numberOfInstances":{
            "type":"number"
        },
        "bodySite":{
            "$ref":"#/definitions/Account_type_coding"
        },
        "instance":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImagingStudy_instance"
            },
            "minItems":1
        }
    }
}

Nested Schema : instance

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImagingStudy_instance

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

Type: object

Show Source

number: number
sopClass(optional): object ActivityDefinition_code
uid: string

Minimum Length: 1

{
    "required":[
        "number",
        "uid"
    ],
    "properties":{
        "uid":{
            "type":"string",
            "minLength":1
        },
        "sopClass":{
            "$ref":"#/definitions/ActivityDefinition_code"
        },
        "number":{
            "type":"number"
        }
    }
}

Update ImagingStudy Resource

Request

Response

200 Response