HDR FHIR API

GET NutritionOrder Resource Bundle

get

/oracle-fhir-server/fhir/NutritionOrder

This endpoint supports the retrieval of NutritionOrder resource list.It returns Bundle of NutritionOrder resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
additive(optional): string

Type of module component to add to the feeding
datetime(optional): string(date)

Return nutrition orders requested on this date
encounter(optional): string

Return nutrition orders with this encounter identifier
formula(optional): string

Type of enteral or infant formula
identifier(optional): string

Return nutrition orders with this external identifier
instantiates-canonical(optional): string

Instantiates FHIR protocol or definition
instantiates-uri(optional): string

Instantiates external protocol or definition
oraldiet(optional): string

Type of diet that can be consumed orally (i.e., take via the mouth).
patient(optional): string

The identity of the person who requires the diet, formula or nutritional supplement
provider(optional): string

The identity of the provider who placed the nutrition order
status(optional): string

Status of the nutrition order.
supplement(optional): string

Type of supplement product requested

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object NutritionOrder

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

Nested Schema : NutritionOrder

Type: object

Show Source

allergyIntolerance: array allergyIntolerance

Minimum Number of Items: 1

Unique Items Required: true
dateTime: string

Minimum Length: 1
encounter: object Account_subject
excludeFoodModifier: array excludeFoodModifier

Minimum Number of Items: 1

Unique Items Required: true
foodPreferenceModifier: array foodPreferenceModifier

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

Minimum Length: 1
meta: object Account_meta
oralDiet: object NutritionOrder_oralDiet
orderer: object Account_subject
patient: object Account_subject
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "allergyIntolerance",
        "dateTime",
        "encounter",
        "excludeFoodModifier",
        "foodPreferenceModifier",
        "id",
        "identifier",
        "intent",
        "meta",
        "oralDiet",
        "orderer",
        "patient",
        "resourceType",
        "status",
        "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
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "intent":{
            "type":"string",
            "minLength":1
        },
        "patient":{
            "$ref":"#/definitions/Account_subject"
        },
        "encounter":{
            "$ref":"#/definitions/Account_subject"
        },
        "dateTime":{
            "type":"string",
            "minLength":1
        },
        "orderer":{
            "$ref":"#/definitions/Account_subject"
        },
        "allergyIntolerance":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "foodPreferenceModifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "excludeFoodModifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/NutritionOrder_excludeFoodModifier"
            },
            "minItems":1
        },
        "oralDiet":{
            "$ref":"#/definitions/NutritionOrder_oralDiet"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : allergyIntolerance

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object NutritionOrder_excludeFoodModifier

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

Nested Schema : foodPreferenceModifier

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

Type: object

Show Source

instruction: string

Minimum Length: 1
nutrient: array nutrient

Minimum Number of Items: 1

Unique Items Required: true
type: array type

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "instruction",
        "nutrient",
        "type"
    ],
    "properties":{
        "type":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Communication_medium"
            },
            "minItems":1
        },
        "nutrient":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/NutritionOrder_oralDiet_nutrient"
            },
            "minItems":1
        },
        "instruction":{
            "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 : NutritionOrder_excludeFoodModifier

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

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object NutritionOrder_coding

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

Nested Schema : NutritionOrder_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1
version: string

Minimum Length: 1

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

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object NutritionOrder_oralDiet_nutrient

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

Nested Schema : type

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Communication_medium

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

Nested Schema : NutritionOrder_oralDiet_nutrient

Type: object

Show Source

amount(optional): object FamilyMemberHistory_onsetAge
modifier(optional): object ActivityDefinition_valueCodeableConcept

{
    "properties":{
        "modifier":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "amount":{
            "$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 : 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 : 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 : Communication_medium

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true
text: string

Minimum Length: 1

{
    "required":[
        "text"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        },
        "text":{
            "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
}