HDR FHIR API

Root Schema : DocumentManifest

Type: object

Show Source

author: array author

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
created: string

Minimum Length: 1
description: 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
recipient: array recipient

Minimum Number of Items: 1

Unique Items Required: true
related: array related

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
source: string

Minimum Length: 1
status: string

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

{
    "type":"object",
    "required":[
        "author",
        "contained",
        "content",
        "created",
        "description",
        "id",
        "identifier",
        "masterIdentifier",
        "meta",
        "recipient",
        "related",
        "resourceType",
        "source",
        "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/DocumentManifest_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
        },
        "type":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "created":{
            "type":"string",
            "minLength":1
        },
        "author":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "recipient":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "source":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "content":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "related":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/DocumentManifest_related"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object DocumentManifest_contained

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

Nested Schema : content

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

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object DocumentManifest_related

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

Type: object

Show Source

text: string

Minimum Length: 1

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

Nested Schema : DocumentManifest_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
telecom(optional): array telecom

Minimum Number of Items: 1

Unique Items Required: true

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

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

Type: object

Show Source

identifier(optional): object Account_identifier
ref(optional): object Account_coverage

{
    "properties":{
        "identifier":{
            "$ref":"#/definitions/Account_identifier"
        },
        "ref":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

Create DocumentManifest Resource

Request

Response

201 Response