HDR FHIR API

Root Schema : Composition

Type: object

Show Source

attester: array attester

Minimum Number of Items: 1

Unique Items Required: true
author: array author

Minimum Number of Items: 1

Unique Items Required: true
category: array category

Minimum Number of Items: 1

Unique Items Required: true
confidentiality: string

Minimum Length: 1
custodian: object Account_subject
date: string

Minimum Length: 1
encounter: object Account_coverage
event: array event

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
identifier: object Account_identifier
meta: object Account_meta
relatesTo: array relatesTo

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
section: array section

Minimum Number of Items: 1

Unique Items Required: true
status: string

Minimum Length: 1
subject: object Account_subject
text: object Account_text
title: string

Minimum Length: 1
type: object ActivityDefinition_valueCodeableConcept

{
    "type":"object",
    "required":[
        "attester",
        "author",
        "category",
        "confidentiality",
        "custodian",
        "date",
        "encounter",
        "event",
        "id",
        "identifier",
        "meta",
        "relatesTo",
        "resourceType",
        "section",
        "status",
        "subject",
        "text",
        "title",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "$ref":"#/definitions/Account_identifier"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "category":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "subject":{
            "$ref":"#/definitions/Account_subject"
        },
        "encounter":{
            "$ref":"#/definitions/Account_coverage"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "author":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "confidentiality":{
            "type":"string",
            "minLength":1
        },
        "attester":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Composition_attester"
            },
            "minItems":1
        },
        "custodian":{
            "$ref":"#/definitions/Account_subject"
        },
        "relatesTo":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Composition_relatesTo"
            },
            "minItems":1
        },
        "event":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Composition_event"
            },
            "minItems":1
        },
        "section":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Composition_section"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : attester

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Composition_attester

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

Nested Schema : author

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_subject

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

Nested Schema : category

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

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

Nested Schema : Account_subject

Type: object

Show Source

display: string

Minimum Length: 1
reference: string

Minimum Length: 1

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

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

Nested Schema : event

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Composition_event

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Composition_relatesTo

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

Nested Schema : section

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Composition_section

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

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/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : Composition_attester

Type: object

Show Source

mode: string

Minimum Length: 1
party(optional): object Account_subject
time: string

Minimum Length: 1

{
    "required":[
        "mode",
        "time"
    ],
    "properties":{
        "mode":{
            "type":"string",
            "minLength":1
        },
        "time":{
            "type":"string",
            "minLength":1
        },
        "party":{
            "$ref":"#/definitions/Account_subject"
        }
    }
}

Nested Schema : AdverseEvent_category

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : coding

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

Type: object

Show Source

code(optional): array code

Minimum Number of Items: 1

Unique Items Required: true
detail(optional): array detail

Minimum Number of Items: 1

Unique Items Required: true
period(optional): object Account_servicePeriod

{
    "properties":{
        "code":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "period":{
            "$ref":"#/definitions/Account_servicePeriod"
        },
        "detail":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        }
    }
}

Nested Schema : code

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

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

Nested Schema : detail

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

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

Nested Schema : Account_servicePeriod

Type: object

Show Source

end: string

Minimum Length: 1
start: string

Minimum Length: 1

{
    "required":[
        "end",
        "start"
    ],
    "properties":{
        "start":{
            "type":"string",
            "minLength":1
        },
        "end":{
            "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 : Composition_relatesTo

Type: object

Show Source

code: string

Minimum Length: 1
targetReference(optional): object Account_coverage

{
    "required":[
        "code"
    ],
    "properties":{
        "code":{
            "type":"string",
            "minLength":1
        },
        "targetReference":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

Nested Schema : Composition_section

Type: object

Show Source

code(optional): object ActivityDefinition_valueCodeableConcept
entry(optional): array entry

Minimum Number of Items: 1

Unique Items Required: true
mode: string

Minimum Length: 1
orderedBy(optional): object ActivityDefinition_valueCodeableConcept
text(optional): object Account_text
title: string

Minimum Length: 1

{
    "required":[
        "mode",
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "mode":{
            "type":"string",
            "minLength":1
        },
        "orderedBy":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "entry":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        }
    }
}

Nested Schema : entry

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

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

Nested Schema : coding

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
}

GET Composition Resource by version ID

Request

Response

200 Response