HDR FHIR API

Root Schema : schema

Type: array

Show Source

Array of: object MedicinalProduct

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MedicinalProduct"
    }
}

Nested Schema : MedicinalProduct

Type: object

Show Source

attachedDocument: array attachedDocument

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
manufacturingBusinessOperation: array manufacturingBusinessOperation

Minimum Number of Items: 1

Unique Items Required: true
masterFile: array masterFile

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
name: array name

Minimum Number of Items: 1

Unique Items Required: true
productClassification: array productClassification

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "attachedDocument",
        "id",
        "identifier",
        "manufacturingBusinessOperation",
        "masterFile",
        "meta",
        "name",
        "productClassification",
        "resourceType",
        "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
        },
        "productClassification":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "attachedDocument":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "masterFile":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "name":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/MedicinalProduct_name"
            },
            "minItems":1
        },
        "manufacturingBusinessOperation":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/MedicinalProduct_manufacturingBusinessOperation"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : attachedDocument

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object MedicinalProduct_manufacturingBusinessOperation

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

Nested Schema : masterFile

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object MedicinalProduct_name

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

Nested Schema : productClassification

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_jurisdiction

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

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "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 : MedicinalProduct_manufacturingBusinessOperation

Type: object

Show Source

authorisationReferenceNumber(optional): object Account_identifier
effectiveDate: string

Minimum Length: 1
manufacturer(optional): array manufacturer

Minimum Number of Items: 1

Unique Items Required: true
operationType(optional): object Basic_code
regulator(optional): object Account_coverage

{
    "required":[
        "effectiveDate"
    ],
    "properties":{
        "operationType":{
            "$ref":"#/definitions/Basic_code"
        },
        "authorisationReferenceNumber":{
            "$ref":"#/definitions/Account_identifier"
        },
        "effectiveDate":{
            "type":"string",
            "minLength":1
        },
        "manufacturer":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "regulator":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

Nested Schema : manufacturer

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

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

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

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

Type: object

Show Source

countryLanguage(optional): array countryLanguage

Minimum Number of Items: 1

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

Minimum Number of Items: 1

Unique Items Required: true
productName: string

Minimum Length: 1

{
    "required":[
        "productName"
    ],
    "properties":{
        "productName":{
            "type":"string",
            "minLength":1
        },
        "namePart":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/MedicinalProduct_namePart"
            },
            "minItems":1
        },
        "countryLanguage":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/MedicinalProduct_countryLanguage"
            },
            "minItems":1
        }
    }
}

Nested Schema : countryLanguage

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object MedicinalProduct_countryLanguage

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

Nested Schema : namePart

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object MedicinalProduct_namePart

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

Nested Schema : MedicinalProduct_countryLanguage

Type: object

Show Source

country(optional): object Basic_code
jurisdiction(optional): object Basic_code
language(optional): object Basic_code

{
    "properties":{
        "country":{
            "$ref":"#/definitions/Basic_code"
        },
        "jurisdiction":{
            "$ref":"#/definitions/Basic_code"
        },
        "language":{
            "$ref":"#/definitions/Basic_code"
        }
    }
}

Nested Schema : MedicinalProduct_namePart

Type: object

Show Source

part: string

Minimum Length: 1
type(optional): object CapabilityStatement_interaction_1

{
    "required":[
        "part"
    ],
    "properties":{
        "part":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "$ref":"#/definitions/CapabilityStatement_interaction_1"
        }
    }
}

Nested Schema : CapabilityStatement_interaction_1

Type: object

Show Source

code: string

Minimum Length: 1

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

Nested Schema : ActivityDefinition_jurisdiction

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

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

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

GET MedicinalProduct Resource Bundle

Request

Response

200 Response