Elation Care Gaps API

{"openapi":"3.0.2","info":{"title":"Care Gaps API","description":"This API supports the management of definitions, gaps, and webhook notifications.","version":"0.0.1"},"servers":[{"url":"https://caregaps.sandbox.elationemr.com/","description":"CareGaps API - Sandbox Environment"}],"paths":{"/caregaps/api/{quality_program}/definition/":{"get":{"tags":["Definitions"],"summary":"Retrieve a filtered page of definitions","description":"Retrieve a list of definitions.","operationId":"definitions_get_page_caregaps_api__quality_program__definition__get","parameters":[{"required":true,"schema":{"title":"Quality Program","type":"string"},"name":"quality_program","in":"path"},{"required":false,"schema":{"title":"Page Size","minimum":1,"type":"integer","default":5},"name":"page_size","in":"query"},{"required":false,"schema":{"title":"Page Num","minimum":1,"type":"integer","default":1},"name":"page_num","in":"query"},{"required":false,"schema":{"title":"Closing Code","type":"array","items":{"type":"string"}},"name":"closing_code","in":"query"},{"required":false,"schema":{"title":"Definition Id","type":"array","items":{"type":"string"}},"name":"definition_id","in":"query"},{"required":false,"schema":{"title":"External Id","type":"string"},"name":"external_id","in":"query"},{"required":false,"schema":{"title":"Cursor","type":"string"},"name":"cursor","in":"query"},{"required":false,"schema":{"title":"Name","type":"string"},"name":"name","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/IndicatorEnum"},"name":"indicator","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_definitions_get_page_caregaps_api__quality_program__definition__get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefinitionAPIPaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"post":{"tags":["Definitions"],"summary":"Create a new definition.","description":"Create a new definition.","operationId":"definitions_post_caregaps_api__quality_program__definition__post","parameters":[{"required":true,"schema":{"title":"Quality Program","type":"string"},"name":"quality_program","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefinitionAPIModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefinitionAPI"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/caregaps/api/{quality_program}/definition/{definition_id}/":{"get":{"tags":["Definitions"],"summary":"Retrieve an existing definition.","description":"Retrieve a specific definition.","operationId":"definitions_get_caregaps_api__quality_program__definition__definition_id___get","parameters":[{"required":true,"schema":{"title":"Quality Program","type":"string"},"name":"quality_program","in":"path"},{"required":true,"schema":{"title":"Definition Id","type":"string"},"name":"definition_id","in":"path"},{"required":false,"schema":{"title":"Practice Id","type":"string"},"name":"practice_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefinitionAPI"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"delete":{"tags":["Definitions"],"summary":"Delete an existing definition.","description":"Delete a specific definition.","operationId":"definitions_delete_caregaps_api__quality_program__definition__definition_id___delete","parameters":[{"required":true,"schema":{"title":"Quality Program","type":"string"},"name":"quality_program","in":"path"},{"required":true,"schema":{"title":"Definition Id","type":"string"},"name":"definition_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/caregaps/api/{quality_program}/caregap/":{"get":{"tags":["Caregaps"],"summary":"Retrieve a list of existing caregap.","description":"Retrieve a list of Care Gaps with filters specified by query parameters.","operationId":"caregaps_list_caregaps_api__quality_program__caregap__get","parameters":[{"required":true,"schema":{"title":"Quality Program","type":"string"},"name":"quality_program","in":"path"},{"required":false,"schema":{"title":"Practice Id","type":"string"},"name":"practice_id","in":"query"},{"required":false,"schema":{"title":"Page Size","maximum":50,"minimum":1,"type":"integer","default":5},"name":"page_size","in":"query"},{"required":false,"schema":{"title":"Cursor","type":"string"},"name":"cursor","in":"query"},{"required":false,"schema":{"title":"Patient Id","type":"string"},"name":"patient_id","in":"query"},{"required":false,"schema":{"title":"Definition Id","type":"string"},"name":"definition_id","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/StatusEnum"},"name":"status","in":"query"},{"required":false,"schema":{"title":"Closed Date Begin","type":"string","format":"date"},"name":"closed_date_begin","in":"query"},{"required":false,"schema":{"title":"Closed Date End","type":"string","format":"date"},"name":"closed_date_end","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Closing Code","type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaregapAPIPaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"post":{"tags":["Caregaps"],"summary":"Create a new caregap.","description":"Create a new caregap.","operationId":"caregaps_post_caregaps_api__quality_program__caregap__post","parameters":[{"required":true,"schema":{"title":"Quality Program","type":"string"},"name":"quality_program","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaregapAPIModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaregapAPI"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/caregaps/api/{quality_program}/caregap/{caregap_id}/":{"get":{"tags":["Caregaps"],"summary":"Retrieve an existing caregap.","description":"Retrieve a specific Care Gap.","operationId":"caregaps_get_caregaps_api__quality_program__caregap__caregap_id___get","parameters":[{"required":true,"schema":{"title":"Quality Program","type":"string"},"name":"quality_program","in":"path"},{"required":true,"schema":{"title":"Caregap Id","type":"string"},"name":"caregap_id","in":"path"},{"required":false,"schema":{"title":"Practice Id","type":"string"},"name":"practice_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaregapAPI"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"delete":{"tags":["Caregaps"],"summary":"Delete an existing caregap.","description":"Delete a specific Care Gap.","operationId":"caregaps_delete_caregaps_api__quality_program__caregap__caregap_id___delete","parameters":[{"required":true,"schema":{"title":"Quality Program","type":"string"},"name":"quality_program","in":"path"},{"required":true,"schema":{"title":"Caregap Id","type":"string"},"name":"caregap_id","in":"path"},{"required":false,"schema":{"title":"Practice Id","type":"string"},"name":"practice_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"patch":{"tags":["Caregaps"],"summary":"Modifies an existing caregap's closed status.","operationId":"caregaps_modify_caregaps_api__quality_program__caregap__caregap_id___patch","parameters":[{"required":true,"schema":{"title":"Quality Program","type":"string"},"name":"quality_program","in":"path"},{"required":true,"schema":{"title":"Caregap Id","type":"string"},"name":"caregap_id","in":"path"},{"required":false,"schema":{"title":"Practice Id","type":"string"},"name":"practice_id","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaregapPatchAPI"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaregapAPI"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}}},"components":{"schemas":{"Action":{"title":"Action","required":["type","description"],"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ActionEnum"}],"description":"The type of action being performed."},"description":{"title":"Description","type":"string","description":"Human-readable description of the suggested action MAY be presented to the end-user."},"resource":{"title":"Resource","anyOf":[{"$ref":"#/components/schemas/ValueSet"},{"$ref":"#/components/schemas/Observation"},{"$ref":"#/components/schemas/Condition"},{"$ref":"#/components/schemas/ServiceRequest"},{"$ref":"#/components/schemas/Immunization"},{"$ref":"#/components/schemas/AllergyIntolerance"},{"$ref":"#/components/schemas/Communication"},{"$ref":"#/components/schemas/Endpoint"},{"$ref":"#/components/schemas/DocumentReference"}],"description":"A FHIR resource. When the type attribute is create, the resource attribute SHALL contain a new FHIR resource to be created. For update, this holds the updated resource in its entirety and not just the changed fields. Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead."},"resourceId":{"title":"Resourceid","type":"string","description":"A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete."}}},"ActionEnum":{"title":"ActionEnum","enum":["create","update","delete"],"type":"string","description":"An enumeration."},"AllergyIntolerance":{"title":"AllergyIntolerance","required":["patient"],"type":"object","properties":{"resource_type":{"title":"Resource Type","type":"string"},"fhir_comments":{"title":"Fhir Comments","anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"id":{"title":"Logical id of this artifact","maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9\\-.]+$","type":"string","description":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."},"_id":{"title":"Extension field for ``id``.","type":"string"},"implicitRules":{"title":"A set of rules under which this content was created","pattern":"\\S*","type":"string","description":"A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."},"_implicitRules":{"title":"Extension field for ``implicitRules``.","type":"string"},"language":{"title":"Language of the resource content","pattern":"^[^\\s]+(\\s[^\\s]+)*$","type":"string","description":"The base language in which the resource is written."},"_language":{"title":"Extension field for ``language``.","type":"string"},"meta":{"title":"Metadata about the resource","type":"string","description":"The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource."},"contained":{"title":"Contained, inline Resources","type":"array","items":{"type":"string"},"description":"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."},"extension":{"title":"Additional content defined by implementations","type":"array","items":{"type":"string"},"description":"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."},"modifierExtension":{"title":"Extensions that cannot be ignored","type":"array","items":{"type":"string"},"description":"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)."},"text":{"title":"Text summary of the resource, for human interpretation","type":"string","description":"A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."},"asserter":{"title":"Source of the information about the allergy","type":"string","description":"The source of the information about the allergy that is recorded."},"category":{"title":"food | medication | environment | biologic","type":"array","items":{"pattern":"^[^\\s]+(\\s[^\\s]+)*$","type":"string"},"description":"Category of the identified substance."},"_category":{"title":"Extension field for ``category``.","type":"array","items":{"type":"string"}},"clinicalStatus":{"title":"active | inactive | resolved","type":"string","description":"The clinical status of the allergy or intolerance."},"code":{"title":"Code that identifies the allergy or intolerance","type":"string","description":"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\").  Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'.  If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance."},"criticality":{"title":"low | high | unable-to-assess","pattern":"^[^\\s]+(\\s[^\\s]+)*$","type":"string","description":"Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance."},"_criticality":{"title":"Extension field for ``criticality``.","type":"string"},"encounter":{"title":"Encounter when the allergy or intolerance was asserted","type":"string","description":"The encounter when the allergy or intolerance was asserted."},"identifier":{"title":"External ids for this item","type":"array","items":{"type":"integer"},"description":"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."},"lastOccurrence":{"title":"Date(/time) of last known occurrence of a reaction","type":"string","description":"Represents the date and/or time of the last known occurrence of a reaction event.","format":"date-time"},"_lastOccurrence":{"title":"Extension field for ``lastOccurrence``.","type":"string"},"note":{"title":"Additional text not captured in other fields","type":"array","items":{"type":"string"},"description":"Additional narrative about the propensity for the Adverse Reaction, not captured in other fields."},"onsetAge":{"title":"When allergy or intolerance was identified","type":"integer","description":"Estimated or actual date,  date-time, or age when allergy or intolerance was identified."},"onsetDateTime":{"title":"When allergy or intolerance was identified","type":"string","description":"Estimated or actual date,  date-time, or age when allergy or intolerance was identified.","format":"date-time"},"_onsetDateTime":{"title":"Extension field for ``onsetDateTime``.","type":"string"},"onsetPeriod":{"title":"When allergy or intolerance was identified","type":"string","description":"Estimated or actual date,  date-time, or age when allergy or intolerance was identified."},"onsetRange":{"title":"When allergy or intolerance was identified","type":"integer","description":"Estimated or actual date,  date-time, or age when allergy or intolerance was identified."},"onsetString":{"title":"When allergy or intolerance was identified","pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"Estimated or actual date,  date-time, or age when allergy or intolerance was identified."},"_onsetString":{"title":"Extension field for ``onsetString``.","type":"string"},"patient":{"title":"Who the sensitivity is for","type":"string","description":"The patient who has the allergy or intolerance."},"reaction":{"title":"Adverse Reaction Events linked to exposure to substance","type":"array","items":{"type":"string"},"description":"Details about each adverse reaction event linked to exposure to the identified substance."},"recordedDate":{"title":"Date first version of the resource instance was recorded","type":"string","description":"The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.","format":"date-time"},"_recordedDate":{"title":"Extension field for ``recordedDate``.","type":"string"},"recorder":{"title":"Who recorded the sensitivity","type":"string","description":"Individual who recorded the record and takes responsibility for its content."},"type":{"title":"allergy | intolerance - Underlying mechanism (if known)","pattern":"^[^\\s]+(\\s[^\\s]+)*$","type":"string","description":"Identification of the underlying physiological mechanism for the reaction risk."},"_type":{"title":"Extension field for ``type``.","type":"string"},"verificationStatus":{"title":"unconfirmed | confirmed | refuted | entered-in-error","type":"string","description":"Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product)."}},"additionalProperties":false,"description":"Disclaimer: Any field name ends with ``__ext`` does't part of\nResource StructureDefinition, instead used to enable Extensibility feature\nfor FHIR Primitive Data Types.\n\nAllergy or Intolerance (generally: Risk of adverse reaction to a substance).\nRisk of harmful or undesirable, physiological response which is unique to\nan individual and associated with exposure to a substance."},"Body_definitions_get_page_caregaps_api__quality_program__definition__get":{"title":"Body_definitions_get_page_caregaps_api__quality_program__definition__get","type":"object","properties":{"definition_id":{"title":"Definition Id","type":"array","items":{"type":"string"}},"closing_code":{"title":"Closing Code","type":"array","items":{"type":"string"}}}},"CaregapAPI":{"title":"CaregapAPI","required":["definition_id","patient_id","practice_id","created_date","status","id","quality_program"],"type":"object","properties":{"definition_id":{"title":"Definition Id","type":"string","description":"Definition id this caregap is associated with."},"patient_id":{"title":"Patient Id","type":"string","description":"Patient id this caregap is associated with."},"practice_id":{"title":"Practice Id","type":"string","description":"Practice id this caregap is associated with."},"created_date":{"title":"Created Date","type":"string","description":"ISO timestamp for when this caregap was created.","format":"date"},"status":{"allOf":[{"$ref":"#/components/schemas/StatusEnum"}],"description":"Current status of the caregap"},"detail":{"title":"Detail","type":"string","description":"Extra detail about the caregap."},"closed_date":{"title":"Closed Date","type":"string","description":"ISO timestamp for when the caregap was closed.","format":"date"},"closed_by":{"allOf":[{"$ref":"#/components/schemas/ClosedByEnum"}],"description":"Who or what action closed the caregap."},"id":{"title":"Id","type":"string","description":"UUID to identify the caregap"},"quality_program":{"title":"Quality Program","type":"string","description":"Quality program this caregap is associated with."}}},"CaregapAPIModel":{"title":"CaregapAPIModel","required":["definition_id","patient_id","practice_id","created_date","status"],"type":"object","properties":{"definition_id":{"title":"Definition Id","type":"string","description":"Definition id this caregap is associated with."},"patient_id":{"title":"Patient Id","type":"string","description":"Patient id this caregap is associated with."},"practice_id":{"title":"Practice Id","type":"string","description":"Practice id this caregap is associated with."},"created_date":{"title":"Created Date","type":"string","description":"ISO timestamp for when this caregap was created.","format":"date"},"status":{"allOf":[{"$ref":"#/components/schemas/StatusEnum"}],"description":"Current status of the caregap"},"detail":{"title":"Detail","type":"string","description":"Extra detail about the caregap."},"closed_date":{"title":"Closed Date","type":"string","description":"ISO timestamp for when the caregap was closed.","format":"date"},"closed_by":{"allOf":[{"$ref":"#/components/schemas/ClosedByEnum"}],"description":"Who or what action closed the caregap."}}},"CaregapAPIPaginatedResponse":{"title":"CaregapAPIPaginatedResponse","required":["results"],"type":"object","properties":{"results":{"title":"Results","type":"array","items":{"$ref":"#/components/schemas/CaregapAPI"},"description":"Page of results requested"},"cursor":{"title":"Cursor","type":"string","description":"Cursor to query for the next page"},"next_page_url":{"title":"Next Page Url","type":"string","description":"Full URL to query for the next page"}}},"CaregapPatchAPI":{"title":"CaregapPatchAPI","required":["status"],"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/StatusEnum"}],"description":"Current status of the caregap"}}},"ClosedByEnum":{"title":"ClosedByEnum","enum":["API","condition-saved","feedback"],"type":"string","description":"An enumeration."},"Coding":{"title":"Coding","type":"object","properties":{"code":{"title":"Code","type":"string","description":"The code for what is being represented"},"display":{"title":"Display","type":"string","description":"A codesystem for this code."},"system":{"title":"System","type":"string","description":"A short, human-readable label to display."},"context":{"title":"Context","allOf":[{"$ref":"#/components/schemas/CodingContext"}],"description":"Context for the coding within the EHR. For use as part of the closing code structure"}}},"CodingContext":{"title":"CodingContext","type":"object","properties":{"target":{"allOf":[{"$ref":"#/components/schemas/TargetEnum"}],"description":"Application target to constrain this closing code to"}}},"Communication":{"title":"Communication","type":"object","properties":{"resource_type":{"title":"Resource Type","type":"string"},"fhir_comments":{"title":"Fhir Comments","anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"id":{"title":"Logical id of this artifact","maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9\\-.]+$","type":"string","description":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."},"_id":{"title":"Extension field for ``id``.","type":"string"},"implicitRules":{"title":"A set of rules under which this content was created","pattern":"\\S*","type":"string","description":"A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."},"_implicitRules":{"title":"Extension field for ``implicitRules``.","type":"string"},"language":{"title":"Language of the resource content","pattern":"^[^\\s]+(\\s[^\\s]+)*$","type":"string","description":"The base language in which the resource is written."},"_language":{"title":"Extension field for ``language``.","type":"string"},"meta":{"title":"Metadata about the resource","type":"string","description":"The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource."},"contained":{"title":"Contained, inline Resources","type":"array","items":{"type":"string"},"description":"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."},"extension":{"title":"Additional content defined by implementations","type":"array","items":{"type":"string"},"description":"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."},"modifierExtension":{"title":"Extensions that cannot be ignored","type":"array","items":{"type":"string"},"description":"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)."},"text":{"title":"Text summary of the resource, for human interpretation","type":"string","description":"A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."},"about":{"title":"Resources that pertain to this communication","type":"array","items":{"type":"string"},"description":"Other resources that pertain to this communication and to which this communication should be associated."},"basedOn":{"title":"Request fulfilled by this communication","type":"array","items":{"type":"string"},"description":"An order, proposal or plan fulfilled in whole or in part by this Communication."},"category":{"title":"Message category","type":"array","items":{"type":"string"},"description":"The type of message conveyed such as alert, notification, reminder, instruction, etc."},"encounter":{"title":"Encounter created as part of","type":"string","description":"The Encounter during which this Communication was created or to which the creation of this record is tightly associated."},"identifier":{"title":"Unique identifier","type":"array","items":{"type":"integer"},"description":"Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server."},"inResponseTo":{"title":"Reply to","type":"array","items":{"type":"string"},"description":"Prior communication that this communication is in response to."},"instantiatesCanonical":{"title":"Instantiates FHIR protocol or definition","type":"array","items":{"pattern":"\\S*","type":"string"},"description":"The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication."},"_instantiatesCanonical":{"title":"Extension field for ``instantiatesCanonical``.","type":"array","items":{"type":"string"}},"instantiatesUri":{"title":"Instantiates external protocol or definition","type":"array","items":{"pattern":"\\S*","type":"string"},"description":"The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication."},"_instantiatesUri":{"title":"Extension field for ``instantiatesUri``.","type":"array","items":{"type":"string"}},"medium":{"title":"A channel of communication","type":"array","items":{"type":"string"},"description":"A channel that was used for this communication (e.g. email, fax)."},"note":{"title":"Comments made about the communication","type":"array","items":{"type":"string"},"description":"Additional notes or commentary about the communication by the sender, receiver or other interested parties."},"partOf":{"title":"Part of this action","type":"array","items":{"type":"string"}},"payload":{"title":"Message payload","type":"array","items":{"type":"string"},"description":"Text, attachment(s), or resource(s) that was communicated to the recipient."},"priority":{"title":"routine | urgent | asap | stat","pattern":"^[^\\s]+(\\s[^\\s]+)*$","type":"string","description":"Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine."},"_priority":{"title":"Extension field for ``priority``.","type":"string"},"reasonCode":{"title":"Indication for message","type":"array","items":{"type":"string"},"description":"The reason or justification for the communication."},"reasonReference":{"title":"Why was communication done?","type":"array","items":{"type":"string"},"description":"Indicates another resource whose existence justifies this communication."},"received":{"title":"When received","type":"string","description

# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/openapi/elation-care-gaps-api-1.json