HDR FHIR API

Root Schema : MedicationStatement

Type: object

Show Source

category: object ActivityDefinition_valueCodeableConcept
contained: array contained

Minimum Number of Items: 1

Unique Items Required: true
dateAsserted: string

Minimum Length: 1
derivedFrom: array derivedFrom

Minimum Number of Items: 1

Unique Items Required: true
dosage: array dosage

Minimum Number of Items: 1

Unique Items Required: true
effectiveDateTime: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
informationSource: object Account_subject
medicationReference: object Account_coverage
meta: object Account_meta
note: array note

Minimum Number of Items: 1

Unique Items Required: true
reasonCode: array reasonCode

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

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

{
    "type":"object",
    "required":[
        "category",
        "contained",
        "dateAsserted",
        "derivedFrom",
        "dosage",
        "effectiveDateTime",
        "id",
        "identifier",
        "informationSource",
        "medicationReference",
        "meta",
        "note",
        "reasonCode",
        "resourceType",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "contained":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/MedicationStatement_contained"
            },
            "minItems":1
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_identifier"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "category":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "medicationReference":{
            "$ref":"#/definitions/Account_coverage"
        },
        "subject":{
            "$ref":"#/definitions/Account_subject"
        },
        "effectiveDateTime":{
            "type":"string",
            "minLength":1
        },
        "dateAsserted":{
            "type":"string",
            "minLength":1
        },
        "informationSource":{
            "$ref":"#/definitions/Account_subject"
        },
        "derivedFrom":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "reasonCode":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "note":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "dosage":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/MedicationStatement_dosage"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object MedicationStatement_contained

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

Nested Schema : derivedFrom

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object MedicationStatement_dosage

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

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_identifier

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

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

Nested Schema : reasonCode

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

Type: object

Show Source

batch(optional): object MedicationStatement_batch
code(optional): object ActivityDefinition_valueCodeableConcept
form(optional): object ActivityDefinition_valueCodeableConcept
id: string

Minimum Length: 1
ingredient(optional): array ingredient

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
        },
        "code":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "form":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "ingredient":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/MedicationStatement_ingredient"
            },
            "minItems":1
        },
        "batch":{
            "$ref":"#/definitions/MedicationStatement_batch"
        }
    }
}

Nested Schema : MedicationStatement_batch

Type: object

Show Source

expirationDate: string

Minimum Length: 1
lotNumber: string

Minimum Length: 1

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

Nested Schema : ingredient

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object MedicationStatement_ingredient

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

Nested Schema : MedicationStatement_ingredient

Type: object

Show Source

itemCodeableConcept(optional): object ActivityDefinition_valueCodeableConcept
strength(optional): object MedicationStatement_strength

{
    "properties":{
        "itemCodeableConcept":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "strength":{
            "$ref":"#/definitions/MedicationStatement_strength"
        }
    }
}

Nested Schema : MedicationStatement_strength

Type: object

Show Source

denominator: object Immunization_doseQuantity
numerator: object Immunization_doseQuantity

{
    "required":[
        "denominator",
        "numerator"
    ],
    "properties":{
        "numerator":{
            "$ref":"#/definitions/Immunization_doseQuantity"
        },
        "denominator":{
            "$ref":"#/definitions/Immunization_doseQuantity"
        }
    }
}

Nested Schema : Immunization_doseQuantity

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1
value: number

{
    "required":[
        "code",
        "system",
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        },
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : MedicationStatement_dosage

Type: object

Show Source

additionalInstruction(optional): array additionalInstruction

Minimum Number of Items: 1

Unique Items Required: true
asNeededCodeableConcept(optional): object ActivityDefinition_valueCodeableConcept
doseAndRate(optional): array doseAndRate

Minimum Number of Items: 1

Unique Items Required: true
route(optional): object ActivityDefinition_valueCodeableConcept
sequence: number
text: string

Minimum Length: 1
timing(optional): object CarePlan_detail_scheduledTiming

{
    "required":[
        "sequence",
        "text"
    ],
    "properties":{
        "sequence":{
            "type":"number"
        },
        "text":{
            "type":"string",
            "minLength":1
        },
        "additionalInstruction":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "timing":{
            "$ref":"#/definitions/CarePlan_detail_scheduledTiming"
        },
        "asNeededCodeableConcept":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "route":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "doseAndRate":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/MedicationStatement_doseAndRate"
            },
            "minItems":1
        }
    }
}

Nested Schema : additionalInstruction

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

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

Nested Schema : doseAndRate

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object MedicationStatement_doseAndRate

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

Nested Schema : CarePlan_detail_scheduledTiming

Type: object

Show Source

repeat: object CarePlan_detail_scheduledTiming_repeat

{
    "required":[
        "repeat"
    ],
    "properties":{
        "repeat":{
            "$ref":"#/definitions/CarePlan_detail_scheduledTiming_repeat"
        }
    }
}

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

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

Nested Schema : MedicationStatement_doseAndRate

Type: object

Show Source

doseRange(optional): object Goal_detailRange
type(optional): object ActivityDefinition_valueCodeableConcept

{
    "properties":{
        "type":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "doseRange":{
            "$ref":"#/definitions/Goal_detailRange"
        }
    }
}

Nested Schema : Goal_detailRange

Type: object

Show Source

high: object FamilyMemberHistory_onsetAge
low: object FamilyMemberHistory_onsetAge

{
    "required":[
        "high",
        "low"
    ],
    "properties":{
        "low":{
            "$ref":"#/definitions/FamilyMemberHistory_onsetAge"
        },
        "high":{
            "$ref":"#/definitions/FamilyMemberHistory_onsetAge"
        }
    }
}

Nested Schema : FamilyMemberHistory_onsetAge

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1
unit: string

Minimum Length: 1
value: number

{
    "required":[
        "code",
        "system",
        "unit",
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string",
            "minLength":1
        },
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : CarePlan_detail_scheduledTiming_repeat

Type: object

Show Source

frequency: number
period: number
periodUnit: string

Minimum Length: 1

{
    "required":[
        "frequency",
        "period",
        "periodUnit"
    ],
    "properties":{
        "frequency":{
            "type":"number"
        },
        "period":{
            "type":"number"
        },
        "periodUnit":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ActivityDefinition_identifier

Type: object

Show Source

system: string

Minimum Length: 1
use: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "use",
        "value"
    ],
    "properties":{
        "use":{
            "type":"string",
            "minLength":1
        },
        "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 : 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
}

GET MedicationStatement Resource by ID

Request

Response

200 Response