allergy intolerances
Create Allergy Intolerance
post
/organizations/{organizationId}/fhir/3/AllergyIntolerance
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | AllergyIntolerance | This is a AllergyIntolerance resource |
| identifier | array(Identifier) | This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). | |
| clinicalStatus | string | active|inactive|resolved | The clinical status of the allergy or intolerance. |
| verificationStatus | string | unconfirmed|confirmed|refuted|entered-in-error | Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). |
| type | string | allergy|intolerance | Identification of the underlying physiological mechanism for the reaction risk. |
| category | array() | food|medication|environment|biologic | Category of the identified substance. |
| criticality | string | low|high|unable-to-assess | Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. |
| code | CodeableConcept | Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). | |
| patient* | Reference | The patient who has the allergy or intolerance. | |
| onsetDateTime | string | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetAge | Age | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetPeriod | Period | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetRange | Range | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetString | string | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| assertedDate | string | The date on which the existance of the AllergyIntolerance was first asserted or acknowledged. | |
| recorder | Reference | Individual who recorded the record and takes responsibility for its content. | |
| asserter | Reference | The source of the information about the allergy that is recorded. | |
| lastOccurrence | string | Represents the date and/or time of the last known occurrence of a reaction event. | |
| note | array(Annotation) | Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. | |
| reaction | array(AllergyIntolerance_Reaction) | Details about each adverse reaction event linked to exposure to the identified substance. |
Response
keyboard_arrow_down
Patch Allergy Intolerance
patch
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | AllergyIntolerance | This is a AllergyIntolerance resource |
| identifier | array(Identifier) | This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). | |
| clinicalStatus | string | active|inactive|resolved | The clinical status of the allergy or intolerance. |
| verificationStatus | string | unconfirmed|confirmed|refuted|entered-in-error | Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). |
| type | string | allergy|intolerance | Identification of the underlying physiological mechanism for the reaction risk. |
| category | array() | food|medication|environment|biologic | Category of the identified substance. |
| criticality | string | low|high|unable-to-assess | Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. |
| code | CodeableConcept | Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). | |
| patient* | Reference | The patient who has the allergy or intolerance. | |
| onsetDateTime | string | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetAge | Age | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetPeriod | Period | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetRange | Range | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetString | string | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| assertedDate | string | The date on which the existance of the AllergyIntolerance was first asserted or acknowledged. | |
| recorder | Reference | Individual who recorded the record and takes responsibility for its content. | |
| asserter | Reference | The source of the information about the allergy that is recorded. | |
| lastOccurrence | string | Represents the date and/or time of the last known occurrence of a reaction event. | |
| note | array(Annotation) | Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. | |
| reaction | array(AllergyIntolerance_Reaction) | Details about each adverse reaction event linked to exposure to the identified substance. |
Response
keyboard_arrow_down
Read Allergy Intolerance
get
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Allergy Intolerance
get
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Allergy Intolerance
get
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Allergy Intolerance
delete
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Allergy Intolerance
get
/organizations/{organizationId}/fhir/3/AllergyIntolerance
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| asserter | string | ||
| category | string | ||
| clinical-status | string | ||
| code | string | ||
| criticality | string | ||
| date | string | ||
| identifier | string | ||
| last-date | string | ||
| manifestation | string | ||
| onset | string | ||
| patient | string | ||
| recorder | string | ||
| route | string | ||
| severity | string | ||
| type | string | ||
| verification-status | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Allergy Intolerance
get
/organizations/{organizationId}/fhir/3/AllergyIntolerance/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Allergy Intolerance
post
/organizations/{organizationId}/fhir/3/AllergyIntolerance/_search
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| asserter | string | ||
| category | string | ||
| clinical-status | string | ||
| code | string | ||
| criticality | string | ||
| date | string | ||
| identifier | string | ||
| last-date | string | ||
| manifestation | string | ||
| onset | string | ||
| patient | string | ||
| recorder | string | ||
| route | string | ||
| severity | string | ||
| type | string | ||
| verification-status | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | AllergyIntolerance | This is a AllergyIntolerance resource |
| identifier | array(Identifier) | This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). | |
| clinicalStatus | string | active|inactive|resolved | The clinical status of the allergy or intolerance. |
| verificationStatus | string | unconfirmed|confirmed|refuted|entered-in-error | Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). |
| type | string | allergy|intolerance | Identification of the underlying physiological mechanism for the reaction risk. |
| category | array() | food|medication|environment|biologic | Category of the identified substance. |
| criticality | string | low|high|unable-to-assess | Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. |
| code | CodeableConcept | Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). | |
| patient* | Reference | The patient who has the allergy or intolerance. | |
| onsetDateTime | string | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetAge | Age | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetPeriod | Period | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetRange | Range | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetString | string | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| assertedDate | string | The date on which the existance of the AllergyIntolerance was first asserted or acknowledged. | |
| recorder | Reference | Individual who recorded the record and takes responsibility for its content. | |
| asserter | Reference | The source of the information about the allergy that is recorded. | |
| lastOccurrence | string | Represents the date and/or time of the last known occurrence of a reaction event. | |
| note | array(Annotation) | Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. | |
| reaction | array(AllergyIntolerance_Reaction) | Details about each adverse reaction event linked to exposure to the identified substance. |
Response
keyboard_arrow_down
Update Allergy Intolerance
put
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
Request
Headers
| content-type* | string | application/json | application/json |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | AllergyIntolerance | This is a AllergyIntolerance resource |
| identifier | array(Identifier) | This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). | |
| clinicalStatus | string | active|inactive|resolved | The clinical status of the allergy or intolerance. |
| verificationStatus | string | unconfirmed|confirmed|refuted|entered-in-error | Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). |
| type | string | allergy|intolerance | Identification of the underlying physiological mechanism for the reaction risk. |
| category | array() | food|medication|environment|biologic | Category of the identified substance. |
| criticality | string | low|high|unable-to-assess | Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. |
| code | CodeableConcept | Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). | |
| patient* | Reference | The patient who has the allergy or intolerance. | |
| onsetDateTime | string | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetAge | Age | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetPeriod | Period | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetRange | Range | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| onsetString | string | Estimated or actual date, date-time, or age when allergy or intolerance was identified. | |
| assertedDate | string | The date on which the existance of the AllergyIntolerance was first asserted or acknowledged. | |
| recorder | Reference | Individual who recorded the record and takes responsibility for its content. | |
| asserter | Reference | The source of the information about the allergy that is recorded. | |
| lastOccurrence | string | Represents the date and/or time of the last known occurrence of a reaction event. | |
| note | array(Annotation) | Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. | |
| reaction | array(AllergyIntolerance_Reaction) | Details about each adverse reaction event linked to exposure to the identified substance. |
Response
keyboard_arrow_down