Detailed information about health concerns
Retrieving a patient’s health concerns
The logical ID of the patient to retrieve is passed as part of the URL. The logical ID is found as the result of a search.
GET https://tw171.open.allscripts.com/FHIR/Patient/id/Condition?category=health-concern
GET https://tw171.open.allscripts.com/FHIR/Patient/id/Condition?category=health-concern&date=eq2016-01-01
| Name | Required? | Type | Description |
|---|---|---|---|
| id | yes | URL | The logical ID of the patient. This is retrieved using the search function. |
| date | no | string | A string representing a date to include in the search. See below for more information. |
A DAF Condition (Problem) is retuned
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | 0..* | Identifier associated with this condition that is defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. For example, in CDA documents or in written/printed documentation. | |
| patient | Reference(Patient) | 1..1 | Patient who the condition record is associated with. This defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information. |
| encounter | Reference(Encounter) | 0..1 | Encounter during which the condition was first asserted. |
| asserter | Reference(Practitioner, Patient) | 0..1 | Individual who is making the condition statement. This could be a provider or patient reference. |
| dateRecorded | date) | 0..1 | Date when this condition record was created in the EHR, not the date of the most recent updates in severity, abatement, and so forth were specified. The date of the last record modification can be retrieved from the resource metadata. |
| code | CodeableConcept | 1..1 | Identification of the condition, problem, or diagnosis. For more information on this value set, see http://hl7.org/fhir/ValueSet/condition-code. |
| category | CodeableConcept | 0..1 | Category assigned to the condition. The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts. The value set conformance is preferred and options include: Complaint, Symptom, Finding, and Diagnosis. For more information on this value set, see http://hl7.org/fhir/ValueSet/condition-category. |
| clinicalStatus | code | 0..1 | Clinical status of the condition. The value set conformance is preferred and options include: Active, Relapse, Remission, and Resolved. For more information on this value set, see http://hl7.org/fhir/ValueSet/condition-clinical. |
| verificationStatus | code | 1..1 | Verification status of the condition or rather, the verification status to support or decline the clinical status of the condition or diagnosis. The value set conformance is required and options include: Provisional, Differential, Confirmed, Refuted, Entered-in-error, and Unknown. For more information on this value set, see http://hl7.org/fhir/ValueSet/condition-ver-status. |
| severity | CodeableConcept | 0..1 | Subjective severity of the condition. The value set conformance is extensible and options include: Fatal, Severe, Moderate, and Mild. Extensions are allowed. For more information on this value set, see http://hl7.org/fhir/ValueSet/condition-severity. |
| onsetDateTime | dateTime | 0..1 | Estimated or actual date, date-time, or age. A date, when the condition statement was documented. The date recorded represents the date when this particular condition record was created in the EHR, not the date of the most recent updates in severity, abatement, etc. were specified. The date of the last record modification can be retrieved from the resource metadata. |
| onsetQuantity | Quantity | 0..1 | Code if there is a value, and it shall be an expression of time. If system is present, it shall be UCUM. If value is present, it shall be positive. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. In this case, it is used to define the onset of the condition. |
| onsetPeriod | Period | 0..1 | A time period defined by a start and end date/time. A period specifies a range of times. The context of use will specify whether the entire range applies (for example, “the patient was an inpatient of the hospital for this time range”) or one value from the period applies For example, “give to the patient between 2 and 4 pm on 24-Jun 2013.” |
| onsetRange | Hl7.Fhir.Model.Range | 0..1 | Set of ordered quantity values defined by a low and high limit. A range specifies a set of possible values; usually one value from the range applies. For example, “give the patient between 2 and 4 tablets.” Ranges are typically used in instructions. |
| onsetString | String | 0..1 | Sequence of Unicode characters to convey the estimated onset of when the condition started. |
| abatementDateTime | dateTime | 0..1 | Estimated or actual date or date-time when the condition statement was resolved or in remission. |
| abatementQuantity | Quantity | 0..1 | Code if there is a value and it shall be an expression of time. If system is present, it shall be UCUM. If value is present, it shall be positive. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. In this case, it is used to indicate when the condition was resolved or in remission. |
| abatementBoolean | Boolean | 0..1 | There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition was resolved or in remission; applications and users should generally assume that the condition is still valid. |
| abatementPeriod | Period | 0..1 | Time period defined by a start and end date/time. A period specifies a range of times for if or when the condition was resolved or in remission. |
| abatementRange | Hl7.Fhir.Model.Range | 0..1 | Set of ordered quantity values defined by a low and high limit. A range specifies a set of possible values; usually one value from the range applies. In this case, the range defines if and when the condition was resolved or in remission. |
| abatementString | String | 0..1 | Sequence of Unicode characters to convey when the condition was resolved or in remission. |
| stage | 0..1 | Set of codified values for which the conformance is example and is typically used to indicate stages of cancer and other conditions. Stage/grade, usually assessed formally. For more information on this value set, see http://hl7.org/fhir/valueset-condition-stage.html. | |
| – stage.summary | CodeableConcept | 0..1 | Simple summary of the stage such as “Stage 3.” The determination of the stage is disease-specific. For more information on this value set, see http://hl7.org/fhir/ValueSet/condition-stage. |
| – stage.assessment | Reference(ClinicalImpression, DiagnosticReport, Observation) | 0..* | Reference to a formal record of the evidence on which the staging assessment is based. Reference resources include: ClinicalImpression, DiagnosticReport, and Observation. |
| evidence | 0..* | Supporting evidence or manifestations that are the basis on which this condition is suspected or confirmed. The evidence may be a simple list of coded symptoms/manifestations, references to observations or formal assessments, or both. | |
| – evidence.code | CodeableConcept | 0..1 | Manifestation or symptom that led to the recording of this condition. This includes a value set where the conformance is examples that describe the manifestations or symptoms. For more information on this value set, see http://hl7.org/fhir/ValueSet/manifestation-or-symptom. |
| – evidence.detail | Reference(Resource) | 0..* | Supporting information found elsewhere, such as links to other relevant information, including pathology reports. |
| bodySite | CodeableConcept | 0..* | Anatomical location, if relevant. This value set includes all the Anatomical Structure SNOMED CT codes. For example, codes with an is-a relationship with 91723000: Anatomical structure. For more information on this value set, see http://hl7.org/fhir/ValueSet/body-site. |
| notes | string | 0..1 | Additional information about the condition. This is a general note or comment entry for further description of the condition, diagnosis, and prognosis. |
Searching by date
Dates are passed as query parameters on the URL. Since the URL parameters cannot handle comparators (for example, >, <=) these are passed in as part of the date.
date=eq2016-01-01
date=gt2016-01-01
The following comparators are supported:
| Comparator | Description |
|---|---|
| eq | equal |
| gt | greater than |
| ge | greater than or equal |
| lt | less than |
| le | less than or equal |
To search for a date range, pass in the date twice.
e.g. date=ge2010-01-01&date=le2010-12-31
This search would include every day in the year 2010.