HDR FHIR API

Root Schema : DocumentReference

Type: object

Show Source

authenticator: object Account_coverage
author: array author

Minimum Number of Items: 1

Unique Items Required: true
category: array category

Minimum Number of Items: 1

Unique Items Required: true
contained: array contained

Minimum Number of Items: 1

Unique Items Required: true
content: array content

Minimum Number of Items: 1

Unique Items Required: true
context: object DocumentReference_context
custodian: object Account_coverage
date: string

Minimum Length: 1
description: string

Minimum Length: 1
docStatus: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
masterIdentifier: object Account_identifier
meta: object Account_meta
relatesTo: array relatesTo

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
securityLabel: array securityLabel

Minimum Number of Items: 1

Unique Items Required: true
status: string

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

{
    "type":"object",
    "required":[
        "authenticator",
        "author",
        "category",
        "contained",
        "content",
        "context",
        "custodian",
        "date",
        "description",
        "docStatus",
        "id",
        "identifier",
        "masterIdentifier",
        "meta",
        "relatesTo",
        "resourceType",
        "securityLabel",
        "status",
        "subject",
        "text",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "contained":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CareTeam_contained"
            },
            "minItems":1
        },
        "masterIdentifier":{
            "$ref":"#/definitions/Account_identifier"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "docStatus":{
            "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_coverage"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "author":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "authenticator":{
            "$ref":"#/definitions/Account_coverage"
        },
        "custodian":{
            "$ref":"#/definitions/Account_coverage"
        },
        "relatesTo":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/DocumentReference_relatesTo"
            },
            "minItems":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "securityLabel":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "content":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/DocumentReference_content"
            },
            "minItems":1
        },
        "context":{
            "$ref":"#/definitions/DocumentReference_context"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

Nested Schema : author

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CareTeam_contained

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

Nested Schema : content

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object DocumentReference_content

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

Nested Schema : DocumentReference_context

Type: object

Show Source

encounter: array encounter

Minimum Number of Items: 1

Unique Items Required: true
event: array event

Minimum Number of Items: 1

Unique Items Required: true
facilityType: object ActivityDefinition_valueCodeableConcept
period: object Account_servicePeriod
practiceSetting: object ActivityDefinition_valueCodeableConcept
related: array related

Minimum Number of Items: 1

Unique Items Required: true
sourcePatientInfo: object Account_coverage

{
    "required":[
        "encounter",
        "event",
        "facilityType",
        "period",
        "practiceSetting",
        "related",
        "sourcePatientInfo"
    ],
    "properties":{
        "encounter":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "event":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "period":{
            "$ref":"#/definitions/Account_servicePeriod"
        },
        "facilityType":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "practiceSetting":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "sourcePatientInfo":{
            "$ref":"#/definitions/Account_coverage"
        },
        "related":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/DocumentReference_context_related"
            },
            "minItems":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_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 DocumentReference_relatesTo

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

Nested Schema : securityLabel

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_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 : 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 : CareTeam_contained

Type: object

Show Source

id: string

Minimum Length: 1
name(optional): array name

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

Nested Schema : name

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CareTeam_name

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

Nested Schema : CareTeam_name

Type: object

Show Source

family: string

Minimum Length: 1
given(optional): array given

{
    "required":[
        "family"
    ],
    "properties":{
        "family":{
            "type":"string",
            "minLength":1
        },
        "given":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        }
    }
}

Nested Schema : given

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : DocumentReference_content

Type: object

Show Source

attachment(optional): object DocumentReference_attachment
format(optional): object Account_type_coding

{
    "properties":{
        "attachment":{
            "$ref":"#/definitions/DocumentReference_attachment"
        },
        "format":{
            "$ref":"#/definitions/Account_type_coding"
        }
    }
}

Nested Schema : DocumentReference_attachment

Type: object

Show Source

contentType: string

Minimum Length: 1
creation: string

Minimum Length: 1
hash: string

Minimum Length: 1
language: string

Minimum Length: 1
size: number
title: string

Minimum Length: 1
url: string

Minimum Length: 1

{
    "required":[
        "contentType",
        "creation",
        "hash",
        "language",
        "size",
        "title",
        "url"
    ],
    "properties":{
        "contentType":{
            "type":"string",
            "minLength":1
        },
        "language":{
            "type":"string",
            "minLength":1
        },
        "url":{
            "type":"string",
            "minLength":1
        },
        "size":{
            "type":"number"
        },
        "hash":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "creation":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : encounter

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

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_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 : related

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object DocumentReference_context_related

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

Nested Schema : DocumentReference_context_related

Type: object

Show Source

identifier(optional): object Account_identifier
reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        },
        "identifier":{
            "$ref":"#/definitions/Account_identifier"
        }
    }
}

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

Type: object

Show Source

code: string

Minimum Length: 1
target(optional): object Account_coverage

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

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
}

Create DocumentReference Resource

Request

Response

201 Response