API documentation for HeyDonto API users
Sort the results by a given field, e.g. _sort=family or _sort=-date.
Restrict returned fields, e.g. _elements=identifier,name.
Filter by last update time, e.g. _lastUpdated=ge2024-01-01.
Search for resources by identifier token, e.g. identifier=http://hospital.org|12345.
Include related resources, e.g. _include=Appointment:patient.
Reverse include related resources, e.g. _revinclude=Observation:subject.
Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5.
Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag.
Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL.
Search by profile in resource meta, e.g. _profile=http://example.org/fhir/StructureDefinition/custom-profile.
Search Patients by birthdate, e.g. birthdate=ge2000-01-01 or birthdate=lt2010-01-01.
Partial match on Patient name, e.g. name:contains=lic.
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/allergy-intolerance?_count=10&_elements=identifier%2Cname&_has=Observation%3Asubject%3Acode%3Dhttp%3A%2F%2Floinc.org%2C1234-5&_id=abc123&_include=Appointment%3Apatient&_lastUpdated=string&_page_token=CgYK...&_profile=http%3A%2F%2Fexample.org%2Ffhir%2FStructureDefinition%2Fcustom-profile&_revinclude=Observation%3Asubject&_security=RBAC%2CCONFIDENTIAL&_sort=family&_tag=http%3A%2F%2Fexample.org%2Ftags%2Csample-tag&birthdate=ge2000-01-01&identifier=http%3A%2F%2Fhospital.org%2C12345&name%3Acontains=lic&name%3Aexact=Alice&patient.name=Alice' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Indicates the purpose of this bundle - how it is intended to be used.
An instant in time - known at least to the second
A series of links that provide context to this bundle.
An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
{ "resourceType": "Bundle", "type": "searchset", "total": 100, "link": [ { … }, { … }, { … }, { … } ], "entry": [ { … } ] }
This is a AllergyIntolerance resource
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Identification of the underlying physiological mechanism for the reaction risk.
Category of the identified substance.
Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A reference from one resource to another.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
Details about each adverse reaction event linked to exposure to the identified substance.
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/allergy-intolerance' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "AllergyIntolerance",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 49476534</p><p><b>clinicalStatus</b>: Active <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code '\''active'\'' = '\''Active'\'', given as '\''Active'\''})</span></p><p><b>verificationStatus</b>: Confirmed <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code '\''confirmed'\'' = '\''Confirmed'\'', given as '\''Confirmed'\''})</span></p><p><b>type</b>: allergy</p><p><b>category</b>: food</p><p><b>criticality</b>: high</p><p><b>code</b>: Cashew nuts <span>(Details : {SNOMED CT code '\''227493005'\'' = '\''Cashew nuts'\'', given as '\''Cashew nuts'\''})</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>onset</b>: 01/01/2004</p><p><b>recordedDate</b>: 09/10/2014 2:58:00 PM</p><p><b>recorder</b>: <a>Practitioner/example</a></p><p><b>asserter</b>: <a>Patient/example</a></p><p><b>lastOccurrence</b>: 01/06/2012</p><p><b>note</b>: The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract.</p><blockquote><p><b>reaction</b></p><p><b>substance</b>: cashew nut allergenic extract Injectable Product <span>(Details : {RxNorm code '\''1160593'\'' = '\''cashew nut allergenic extract Injectable Product'\'', given as '\''cashew nut allergenic extract Injectable Product'\''})</span></p><p><b>manifestation</b>: Anaphylactic reaction <span>(Details : {SNOMED CT code '\''39579001'\'' = '\''Anaphylaxis'\'', given as '\''Anaphylactic reaction'\''})</span></p><p><b>description</b>: Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered</p><p><b>onset</b>: 12/06/2012</p><p><b>severity</b>: severe</p><p><b>exposureRoute</b>: Subcutaneous route <span>(Details : {SNOMED CT code '\''34206005'\'' = '\''Subcutaneous route'\'', given as '\''Subcutaneous route'\''})</span></p></blockquote><blockquote><p><b>reaction</b></p><p><b>manifestation</b>: Urticaria <span>(Details : {SNOMED CT code '\''64305001'\'' = '\''Urticaria'\'', given as '\''Urticaria'\''})</span></p><p><b>onset</b>: 01/01/2004</p><p><b>severity</b>: moderate</p><p><b>note</b>: The patient reports that the onset of urticaria was within 15 minutes of eating cashews.</p></blockquote></div>"
},
"identifier": [
{
"system": "http://acme.com/ids/patients/risks",
"value": "49476534"
}
],
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active",
"display": "Active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed",
"display": "Confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "high",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "227493005",
"display": "Cashew nuts"
}
]
},
"patient": {
"reference": "Patient/example"
},
"onsetDateTime": "2004",
"recordedDate": "2014-10-09T14:58:00+11:00",
"recorder": {
"reference": "Practitioner/example"
},
"asserter": {
"reference": "Patient/example"
},
"lastOccurrence": "2012-06",
"note": [
{
"text": "The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract."
}
],
"reaction": [
{
"substance": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "1160593",
"display": "cashew nut allergenic extract Injectable Product"
}
]
},
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39579001",
"display": "Anaphylactic reaction"
}
]
}
],
"description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered",
"onset": "2012-06-12",
"severity": "severe",
"exposureRoute": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "34206005",
"display": "Subcutaneous route"
}
]
}
},
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "64305001",
"display": "Urticaria"
}
]
}
],
"onset": "2004",
"severity": "moderate",
"note": [
{
"text": "The patient reports that the onset of urticaria was within 15 minutes of eating cashews."
}
]
}
]
}'This is a AllergyIntolerance resource
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Identification of the underlying physiological mechanism for the reaction risk.
Category of the identified substance.
Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A reference from one resource to another.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
Details about each adverse reaction event linked to exposure to the identified substance.
{ "resourceType": "AllergyIntolerance", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 49476534</p><p><b>clinicalStatus</b>: Active <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code 'active' = 'Active', given as 'Active'})</span></p><p><b>verificationStatus</b>: Confirmed <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code 'confirmed' = 'Confirmed', given as 'Confirmed'})</span></p><p><b>type</b>: allergy</p><p><b>category</b>: food</p><p><b>criticality</b>: high</p><p><b>code</b>: Cashew nuts <span>(Details : {SNOMED CT code '227493005' = 'Cashew nuts', given as 'Cashew nuts'})</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>onset</b>: 01/01/2004</p><p><b>recordedDate</b>: 09/10/2014 2:58:00 PM</p><p><b>recorder</b>: <a>Practitioner/example</a></p><p><b>asserter</b>: <a>Patient/example</a></p><p><b>lastOccurrence</b>: 01/06/2012</p><p><b>note</b>: The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract.</p><blockquote><p><b>reaction</b></p><p><b>substance</b>: cashew nut allergenic extract Injectable Product <span>(Details : {RxNorm code '1160593' = 'cashew nut allergenic extract Injectable Product', given as 'cashew nut allergenic extract Injectable Product'})</span></p><p><b>manifestation</b>: Anaphylactic reaction <span>(Details : {SNOMED CT code '39579001' = 'Anaphylaxis', given as 'Anaphylactic reaction'})</span></p><p><b>description</b>: Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered</p><p><b>onset</b>: 12/06/2012</p><p><b>severity</b>: severe</p><p><b>exposureRoute</b>: Subcutaneous route <span>(Details : {SNOMED CT code '34206005' = 'Subcutaneous route', given as 'Subcutaneous route'})</span></p></blockquote><blockquote><p><b>reaction</b></p><p><b>manifestation</b>: Urticaria <span>(Details : {SNOMED CT code '64305001' = 'Urticaria', given as 'Urticaria'})</span></p><p><b>onset</b>: 01/01/2004</p><p><b>severity</b>: moderate</p><p><b>note</b>: The patient reports that the onset of urticaria was within 15 minutes of eating cashews.</p></blockquote></div>" }, "identifier": [ { … } ], "clinicalStatus": { "coding": [ … ] }, "verificationStatus": { "coding": [ … ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ … ] }, "patient": { "reference": "Patient/example" }, "onsetDateTime": "2004", "recordedDate": "2014-10-09T14:58:00+11:00", "recorder": { "reference": "Practitioner/example" }, "asserter": { "reference": "Patient/example" }, "lastOccurrence": "2012-06", "note": [ { … } ], "reaction": [ { … }, { … } ] }
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/allergy-intolerance/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'This is a AllergyIntolerance resource
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Identification of the underlying physiological mechanism for the reaction risk.
Category of the identified substance.
Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A reference from one resource to another.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
Details about each adverse reaction event linked to exposure to the identified substance.
{ "resourceType": "AllergyIntolerance", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 49476534</p><p><b>clinicalStatus</b>: Active <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code 'active' = 'Active', given as 'Active'})</span></p><p><b>verificationStatus</b>: Confirmed <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code 'confirmed' = 'Confirmed', given as 'Confirmed'})</span></p><p><b>type</b>: allergy</p><p><b>category</b>: food</p><p><b>criticality</b>: high</p><p><b>code</b>: Cashew nuts <span>(Details : {SNOMED CT code '227493005' = 'Cashew nuts', given as 'Cashew nuts'})</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>onset</b>: 01/01/2004</p><p><b>recordedDate</b>: 09/10/2014 2:58:00 PM</p><p><b>recorder</b>: <a>Practitioner/example</a></p><p><b>asserter</b>: <a>Patient/example</a></p><p><b>lastOccurrence</b>: 01/06/2012</p><p><b>note</b>: The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract.</p><blockquote><p><b>reaction</b></p><p><b>substance</b>: cashew nut allergenic extract Injectable Product <span>(Details : {RxNorm code '1160593' = 'cashew nut allergenic extract Injectable Product', given as 'cashew nut allergenic extract Injectable Product'})</span></p><p><b>manifestation</b>: Anaphylactic reaction <span>(Details : {SNOMED CT code '39579001' = 'Anaphylaxis', given as 'Anaphylactic reaction'})</span></p><p><b>description</b>: Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered</p><p><b>onset</b>: 12/06/2012</p><p><b>severity</b>: severe</p><p><b>exposureRoute</b>: Subcutaneous route <span>(Details : {SNOMED CT code '34206005' = 'Subcutaneous route', given as 'Subcutaneous route'})</span></p></blockquote><blockquote><p><b>reaction</b></p><p><b>manifestation</b>: Urticaria <span>(Details : {SNOMED CT code '64305001' = 'Urticaria', given as 'Urticaria'})</span></p><p><b>onset</b>: 01/01/2004</p><p><b>severity</b>: moderate</p><p><b>note</b>: The patient reports that the onset of urticaria was within 15 minutes of eating cashews.</p></blockquote></div>" }, "identifier": [ { … } ], "clinicalStatus": { "coding": [ … ] }, "verificationStatus": { "coding": [ … ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ … ] }, "patient": { "reference": "Patient/example" }, "onsetDateTime": "2004", "recordedDate": "2014-10-09T14:58:00+11:00", "recorder": { "reference": "Practitioner/example" }, "asserter": { "reference": "Patient/example" }, "lastOccurrence": "2012-06", "note": [ { … } ], "reaction": [ { … }, { … } ] }
This is a AllergyIntolerance resource
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Identification of the underlying physiological mechanism for the reaction risk.
Category of the identified substance.
Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A reference from one resource to another.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
Details about each adverse reaction event linked to exposure to the identified substance.
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/allergy-intolerance/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "AllergyIntolerance",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 49476534</p><p><b>clinicalStatus</b>: Active <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code '\''active'\'' = '\''Active'\'', given as '\''Active'\''})</span></p><p><b>verificationStatus</b>: Confirmed <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code '\''confirmed'\'' = '\''Confirmed'\'', given as '\''Confirmed'\''})</span></p><p><b>type</b>: allergy</p><p><b>category</b>: food</p><p><b>criticality</b>: high</p><p><b>code</b>: Cashew nuts <span>(Details : {SNOMED CT code '\''227493005'\'' = '\''Cashew nuts'\'', given as '\''Cashew nuts'\''})</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>onset</b>: 01/01/2004</p><p><b>recordedDate</b>: 09/10/2014 2:58:00 PM</p><p><b>recorder</b>: <a>Practitioner/example</a></p><p><b>asserter</b>: <a>Patient/example</a></p><p><b>lastOccurrence</b>: 01/06/2012</p><p><b>note</b>: The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract.</p><blockquote><p><b>reaction</b></p><p><b>substance</b>: cashew nut allergenic extract Injectable Product <span>(Details : {RxNorm code '\''1160593'\'' = '\''cashew nut allergenic extract Injectable Product'\'', given as '\''cashew nut allergenic extract Injectable Product'\''})</span></p><p><b>manifestation</b>: Anaphylactic reaction <span>(Details : {SNOMED CT code '\''39579001'\'' = '\''Anaphylaxis'\'', given as '\''Anaphylactic reaction'\''})</span></p><p><b>description</b>: Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered</p><p><b>onset</b>: 12/06/2012</p><p><b>severity</b>: severe</p><p><b>exposureRoute</b>: Subcutaneous route <span>(Details : {SNOMED CT code '\''34206005'\'' = '\''Subcutaneous route'\'', given as '\''Subcutaneous route'\''})</span></p></blockquote><blockquote><p><b>reaction</b></p><p><b>manifestation</b>: Urticaria <span>(Details : {SNOMED CT code '\''64305001'\'' = '\''Urticaria'\'', given as '\''Urticaria'\''})</span></p><p><b>onset</b>: 01/01/2004</p><p><b>severity</b>: moderate</p><p><b>note</b>: The patient reports that the onset of urticaria was within 15 minutes of eating cashews.</p></blockquote></div>"
},
"identifier": [
{
"system": "http://acme.com/ids/patients/risks",
"value": "49476534"
}
],
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active",
"display": "Active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed",
"display": "Confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "high",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "227493005",
"display": "Cashew nuts"
}
]
},
"patient": {
"reference": "Patient/example"
},
"onsetDateTime": "2004",
"recordedDate": "2014-10-09T14:58:00+11:00",
"recorder": {
"reference": "Practitioner/example"
},
"asserter": {
"reference": "Patient/example"
},
"lastOccurrence": "2012-06",
"note": [
{
"text": "The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract."
}
],
"reaction": [
{
"substance": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "1160593",
"display": "cashew nut allergenic extract Injectable Product"
}
]
},
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39579001",
"display": "Anaphylactic reaction"
}
]
}
],
"description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered",
"onset": "2012-06-12",
"severity": "severe",
"exposureRoute": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "34206005",
"display": "Subcutaneous route"
}
]
}
},
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "64305001",
"display": "Urticaria"
}
]
}
],
"onset": "2004",
"severity": "moderate",
"note": [
{
"text": "The patient reports that the onset of urticaria was within 15 minutes of eating cashews."
}
]
}
]
}'This is a AllergyIntolerance resource
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Identification of the underlying physiological mechanism for the reaction risk.
Category of the identified substance.
Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
A reference from one resource to another.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
Details about each adverse reaction event linked to exposure to the identified substance.
{ "resourceType": "AllergyIntolerance", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 49476534</p><p><b>clinicalStatus</b>: Active <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code 'active' = 'Active', given as 'Active'})</span></p><p><b>verificationStatus</b>: Confirmed <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code 'confirmed' = 'Confirmed', given as 'Confirmed'})</span></p><p><b>type</b>: allergy</p><p><b>category</b>: food</p><p><b>criticality</b>: high</p><p><b>code</b>: Cashew nuts <span>(Details : {SNOMED CT code '227493005' = 'Cashew nuts', given as 'Cashew nuts'})</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>onset</b>: 01/01/2004</p><p><b>recordedDate</b>: 09/10/2014 2:58:00 PM</p><p><b>recorder</b>: <a>Practitioner/example</a></p><p><b>asserter</b>: <a>Patient/example</a></p><p><b>lastOccurrence</b>: 01/06/2012</p><p><b>note</b>: The criticality is high becasue of the observed anaphylactic reaction when challenged with cashew extract.</p><blockquote><p><b>reaction</b></p><p><b>substance</b>: cashew nut allergenic extract Injectable Product <span>(Details : {RxNorm code '1160593' = 'cashew nut allergenic extract Injectable Product', given as 'cashew nut allergenic extract Injectable Product'})</span></p><p><b>manifestation</b>: Anaphylactic reaction <span>(Details : {SNOMED CT code '39579001' = 'Anaphylaxis', given as 'Anaphylactic reaction'})</span></p><p><b>description</b>: Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered</p><p><b>onset</b>: 12/06/2012</p><p><b>severity</b>: severe</p><p><b>exposureRoute</b>: Subcutaneous route <span>(Details : {SNOMED CT code '34206005' = 'Subcutaneous route', given as 'Subcutaneous route'})</span></p></blockquote><blockquote><p><b>reaction</b></p><p><b>manifestation</b>: Urticaria <span>(Details : {SNOMED CT code '64305001' = 'Urticaria', given as 'Urticaria'})</span></p><p><b>onset</b>: 01/01/2004</p><p><b>severity</b>: moderate</p><p><b>note</b>: The patient reports that the onset of urticaria was within 15 minutes of eating cashews.</p></blockquote></div>" }, "identifier": [ { … } ], "clinicalStatus": { "coding": [ … ] }, "verificationStatus": { "coding": [ … ] }, "type": "allergy", "category": [ "food" ], "criticality": "high", "code": { "coding": [ … ] }, "patient": { "reference": "Patient/example" }, "onsetDateTime": "2004", "recordedDate": "2014-10-09T14:58:00+11:00", "recorder": { "reference": "Practitioner/example" }, "asserter": { "reference": "Patient/example" }, "lastOccurrence": "2012-06", "note": [ { … } ], "reaction": [ { … }, { … } ] }
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/allergy-intolerance/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "statusText": "OK", "status": 200 }
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/allergy-intolerance/{id}/history' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'A list of entries representing historical versions of the resource.
{ "resourceType": "Bundle", "type": "history", "entry": [ { … } ], "total": 2 }