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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringAllergyIntoleranceThis is a AllergyIntolerance resource
identifierarray(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).
clinicalStatusstringactive|inactive|resolvedThe clinical status of the allergy or intolerance.
verificationStatusstringunconfirmed|confirmed|refuted|entered-in-errorAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
typestringallergy|intoleranceIdentification of the underlying physiological mechanism for the reaction risk.
categoryarray()food|medication|environment|biologicCategory of the identified substance.
criticalitystringlow|high|unable-to-assessEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
codeCodeableConceptCode 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*ReferenceThe patient who has the allergy or intolerance.
onsetDateTimestringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetAgeAgeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetPeriodPeriodEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetRangeRangeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetStringstringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
assertedDatestringThe date on which the existance of the AllergyIntolerance was first asserted or acknowledged.
recorderReferenceIndividual who recorded the record and takes responsibility for its content.
asserterReferenceThe source of the information about the allergy that is recorded.
lastOccurrencestringRepresents the date and/or time of the last known occurrence of a reaction event.
notearray(Annotation)Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
reactionarray(AllergyIntolerance_Reaction)Details about each adverse reaction event linked to exposure to the identified substance.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAllergyIntoleranceThis is a AllergyIntolerance resource
identifierarray(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).
clinicalStatusstringactive|inactive|resolvedThe clinical status of the allergy or intolerance.
verificationStatusstringunconfirmed|confirmed|refuted|entered-in-errorAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
typestringallergy|intoleranceIdentification of the underlying physiological mechanism for the reaction risk.
categoryarray()food|medication|environment|biologicCategory of the identified substance.
criticalitystringlow|high|unable-to-assessEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
codeCodeableConceptCode 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*ReferenceThe patient who has the allergy or intolerance.
onsetDateTimestringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetAgeAgeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetPeriodPeriodEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetRangeRangeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetStringstringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
assertedDatestringThe date on which the existance of the AllergyIntolerance was first asserted or acknowledged.
recorderReferenceIndividual who recorded the record and takes responsibility for its content.
asserterReferenceThe source of the information about the allergy that is recorded.
lastOccurrencestringRepresents the date and/or time of the last known occurrence of a reaction event.
notearray(Annotation)Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
reactionarray(AllergyIntolerance_Reaction)Details about each adverse reaction event linked to exposure to the identified substance.

Response

Read Allergy Intolerance

get
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Allergy Intolerance

get
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Allergy Intolerance

get
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Allergy Intolerance

delete
/organizations/{organizationId}/fhir/3/AllergyIntolerance/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Allergy Intolerance

get
/organizations/{organizationId}/fhir/3/AllergyIntolerance

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
asserterstring
categorystring
clinical-statusstring
codestring
criticalitystring
datestring
identifierstring
last-datestring
manifestationstring
onsetstring
patientstring
recorderstring
routestring
severitystring
typestring
verification-statusstring

Params

organizationId*string|stringid|slug

Response

Search History Allergy Intolerance

get
/organizations/{organizationId}/fhir/3/AllergyIntolerance/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
asserterstring
categorystring
clinical-statusstring
codestring
criticalitystring
datestring
identifierstring
last-datestring
manifestationstring
onsetstring
patientstring
recorderstring
routestring
severitystring
typestring
verification-statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringAllergyIntoleranceThis is a AllergyIntolerance resource
identifierarray(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).
clinicalStatusstringactive|inactive|resolvedThe clinical status of the allergy or intolerance.
verificationStatusstringunconfirmed|confirmed|refuted|entered-in-errorAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
typestringallergy|intoleranceIdentification of the underlying physiological mechanism for the reaction risk.
categoryarray()food|medication|environment|biologicCategory of the identified substance.
criticalitystringlow|high|unable-to-assessEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
codeCodeableConceptCode 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*ReferenceThe patient who has the allergy or intolerance.
onsetDateTimestringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetAgeAgeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetPeriodPeriodEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetRangeRangeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetStringstringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
assertedDatestringThe date on which the existance of the AllergyIntolerance was first asserted or acknowledged.
recorderReferenceIndividual who recorded the record and takes responsibility for its content.
asserterReferenceThe source of the information about the allergy that is recorded.
lastOccurrencestringRepresents the date and/or time of the last known occurrence of a reaction event.
notearray(Annotation)Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
reactionarray(AllergyIntolerance_Reaction)Details about each adverse reaction event linked to exposure to the identified substance.

Response

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*stringapplication/jsonapplication/json
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAllergyIntoleranceThis is a AllergyIntolerance resource
identifierarray(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).
clinicalStatusstringactive|inactive|resolvedThe clinical status of the allergy or intolerance.
verificationStatusstringunconfirmed|confirmed|refuted|entered-in-errorAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
typestringallergy|intoleranceIdentification of the underlying physiological mechanism for the reaction risk.
categoryarray()food|medication|environment|biologicCategory of the identified substance.
criticalitystringlow|high|unable-to-assessEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
codeCodeableConceptCode 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*ReferenceThe patient who has the allergy or intolerance.
onsetDateTimestringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetAgeAgeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetPeriodPeriodEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetRangeRangeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetStringstringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
assertedDatestringThe date on which the existance of the AllergyIntolerance was first asserted or acknowledged.
recorderReferenceIndividual who recorded the record and takes responsibility for its content.
asserterReferenceThe source of the information about the allergy that is recorded.
lastOccurrencestringRepresents the date and/or time of the last known occurrence of a reaction event.
notearray(Annotation)Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
reactionarray(AllergyIntolerance_Reaction)Details about each adverse reaction event linked to exposure to the identified substance.

Response