EXF-FHIR CarePlan resource enables the user to create the Practitioner’s plan of treatment to deliver care for a particular patient or a group or a community. This includes referring to the patient conditions (Problem list of the Patient) and patient goals (intended objectives set for patient recovery).
Description
:
EXF-FHIR CarePlan resource enables the user to create the Practitioner’s plan of treatment to deliver care for a particular patient or a group or a community. This includes referring to the patient conditions (Problem list of the Patient) and patient goals (intended objectives set for patient recovery).
HTTP Method
:
POST
Request URL
:
STU3/Careplan
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | External Ids for this plan |
| Definition | Reference(PlanDefinition | Questionnaire) | Protocol or definition |
| basedOn | Reference(Careplan) | Fulfills care plan |
| Replaces | Reference(Careplan) | CarePlan replaced by this CarePlan |
| part of | Reference(CarePlan) | Part of referenced CarePlan |
| Status | Code | draft | active | suspended | completed | entered-in-error | cancelled | unknown |
| Intent | Code | proposal | plan | order | option |
| Category | Codeableconcept | Type of plan |
| Title | String | Human-friendly name for the CarePlan |
| Description | String | Summary of nature of plan |
| Subject | Reference(Patient|Group) | Who care plan is for |
| Context | Reference(Encounter|EpisodeOfCare) | Created in context of |
| Period | Period | Time period plan covers |
| Author | Reference(Patient | Practioner | Organization) | Who is responsible for contents of the plan |
| careTeam | Reference(CareTeam) | Who's involved in plan? |
| Addresses | Reference(Condition) | Health issues this plan addresses |
| Supportinginfo | Reference(Any) | Information considered as part of plan |
| Goal | Reference(Goal) | Desired outcome of plan |
| Activity | Backboneelement | Action to occur as part of plan |
| outcomeCodeableConcept | CodeableConcept | Results of the activity |
| outcomeReference | Reference(Any) | Appointment, Encounter, Procedure, etc. |
| Progress | Annotation | Comments about the activity status/progress |
| Reference | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | RequestGroup) | Activity details defined in specific resource |
| Detail | Backbonelement | In-line definition of activity |
| Category | Codeableconcept | diet | drug | encounter | observation | procedure | supply | other |
| Definition | Reference(planDefintion | ActivityDefinition) | Protocol or definition |
| Code | codeableConcept | Detail type of activity |
| reasonCode | Codeableconcept | Why activity should be done or why activity was prohibited |
| reasonReference | Reference(Condition) | Condition triggereing |
| Goal | Reference(Goal) | Goals this activity relates to |
| Status | Code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown |
| statusReason | String | Reason for current status |
| Prohibited | Boolean | Do NOT do |
| Scheduled | When activity is to occur | |
| Location | Reference(Location) | Where it should happen |
| Performer | Referfence(practioner|Organization) | Who will be responsible? |
| Product | What is to be administered/supplied | |
| dailyAmount | SimpleQuantity | How to consume/day? |
| Quantity | SimpleQuantity | How much to administer/supply/consume |
| Description | string | Extra info describing activity to perform |
| Note | Annotation | Comments about the plan |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR CarePlan resource enables the user to retrieve the Practitioner’s plan of treatment, patient conditions and patient goals with their references.
Description
:
EXF-FHIR CarePlan resource enables the user to retrieve the Practitioner’s plan of treatment, patient conditions and patient goals with their references.
HTTP Method
:
GET
Request URL
:
STU3/Careplan
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | External Ids for this plan |
| Definition | Reference(PlanDefinition | Questionnaire) | Protocol or definition |
| basedOn | Reference(Careplan) | Fulfills care plan |
| Replaces | Reference(Careplan) | CarePlan replaced by this CarePlan |
| part of | Reference(CarePlan) | Part of referenced CarePlan |
| Status | Code | draft | active | suspended | completed | entered-in-error | cancelled | unknown |
| Intent | Code | proposal | plan | order | option |
| Category | Codeableconcept | Type of plan |
| Title | String | Human-friendly name for the CarePlan |
| Description | String | Summary of nature of plan |
| Subject | Reference(Patient|Group) | Who care plan is for |
| Context | Reference(Encounter|EpisodeOfCare) | Created in context of |
| Period | Period | Time period plan covers |
| Author | Reference(Patient | Practioner | Organization) | Who is responsible for contents of the plan |
| careTeam | Reference(CareTeam) | Who's involved in plan? |
| Addresses | Reference(Condition) | Health issues this plan addresses |
| Supportinginfo | Reference(Any) | Information considered as part of plan |
| Goal | Reference(Goal) | Desired outcome of plan |
| Activity | Backboneelement | Action to occur as part of plan |
| outcomeCodeableConcept | CodeableConcept | Results of the activity |
| outcomeReference | Reference(Any) | Appointment, Encounter, Procedure, etc. |
| Progress | Annotation | Comments about the activity status/progress |
| Reference | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | RequestGroup) | Activity details defined in specific resource |
| Detail | Backbonelement | In-line definition of activity |
| Category | Codeableconcept | diet | drug | encounter | observation | procedure | supply | other |
| Definition | Reference(planDefintion | ActivityDefinition) | Protocol or definition |
| Code | codeableConcept | Detail type of activity |
| reasonCode | Codeableconcept | Why activity should be done or why activity was prohibited |
| reasonReference | Reference(Condition) | Condition triggereing |
| Goal | Reference(Goal) | Goals this activity relates to |
| Status | Code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown |
| statusReason | String | Reason for current status |
| Prohibited | Boolean | Do NOT do |
| Scheduled | When activity is to occur | |
| Location | Reference(Location) | Where it should happen |
| Performer | Referfence(practioner|Organization) | Who will be responsible? |
| Product | What is to be administered/supplied | |
| dailyAmount | SimpleQuantity | How to consume/day? |
| Quantity | SimpleQuantity | How much to administer/supply/consume |
| Description | string | Extra info describing activity to perform |
| Note | Annotation | Comments about the plan |
EXF-FHIR CarePlan resource enables the user to retrieve the required details based on the different search parameters like plan of treatment, category, conditions and unique ID identifiers.
HTTP Method
:
GET
Request URL
:
STU3/Careplan
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| identifier | Token | CarePlan.identifier |
| Goal | Reference | CarePlan.goal |
| Patient | Reference | CarePlan.subject |
| status | Token | CarePlan.status |
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | External Ids for this plan |
| Definition | Reference(PlanDefinition | Questionnaire) | Protocol or definition |
| basedOn | Reference(Careplan) | Fulfills care plan |
| Replaces | Reference(Careplan) | CarePlan replaced by this CarePlan |
| part of | Reference(CarePlan) | Part of referenced CarePlan |
| Status | Code | draft | active | suspended | completed | entered-in-error | cancelled | unknown |
| Intent | Code | proposal | plan | order | option |
| Category | Codeableconcept | Type of plan |
| Title | String | Human-friendly name for the CarePlan |
| Description | String | Summary of nature of plan |
| Subject | Reference(Patient|Group) | Who care plan is for |
| Context | Reference(Encounter|EpisodeOfCare) | Created in context of |
| Period | Period | Time period plan covers |
| Author | Reference(Patient | Practioner | Organization) | Who is responsible for contents of the plan |
| careTeam | Reference(CareTeam) | Who's involved in plan? |
| Addresses | Reference(Condition) | Health issues this plan addresses |
| Supportinginfo | Reference(Any) | Information considered as part of plan |
| Goal | Reference(Goal) | Desired outcome of plan |
| Activity | Backboneelement | Action to occur as part of plan |
| outcomeCodeableConcept | CodeableConcept | Results of the activity |
| outcomeReference | Reference(Any) | Appointment, Encounter, Procedure, etc. |
| Progress | Annotation | Comments about the activity status/progress |
| Reference | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | RequestGroup) | Activity details defined in specific resource |
| Detail | Backbonelement | In-line definition of activity |
| Category | Codeableconcept | diet | drug | encounter | observation | procedure | supply | other |
| Definition | Reference(planDefintion | ActivityDefinition) | Protocol or definition |
| Code | codeableConcept | Detail type of activity |
| reasonCode | Codeableconcept | Why activity should be done or why activity was prohibited |
| reasonReference | Reference(Condition) | Condition triggereing |
| Goal | Reference(Goal) | Goals this activity relates to |
| Status | Code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown |
| statusReason | String | Reason for current status |
| Prohibited | Boolean | Do NOT do |
| Scheduled | When activity is to occur | |
| Location | Reference(Location) | Where it should happen |
| Performer | Referfence(practioner|Organization) | Who will be responsible? |
| Product | What is to be administered/supplied | |
| dailyAmount | SimpleQuantity | How to consume/day? |
| Quantity | SimpleQuantity | How much to administer/supply/consume |
| Description | string | Extra info describing activity to perform |
| Note | Annotation | Comments about the plan |
EXF-FHIR Organization resource enables the user to create the details of an organization that includes institutions, companies, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
HTTP Method
:
POST
Request URL
:
STU3/Organisation
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | Identifies this organization across multiple systems |
| Active | boolean | Whether the organization's record is still in active use |
| type | CodeableConcept | Kind of organization |
| name | String | Name used for the organization |
| alias | String | A list of alternate names that the organization is known as, or was known as in the past |
| telecom | ContactPoint | A contact detail for the organization |
| address | Address | An address for the organization |
| partOf | Reference(Organization) | The organization of which this organization forms a part |
| Addressed | Address | Patient Permanent address |
| Contact | BackboneElement | Contact for the organization for a certain purpose |
| Purpose | CodeableConcept | The type of contact |
| Name | HumanName | A name associated with the contact |
| telecom | ContactPoint | Contact details for a Contact |
| Address | Address | Visting or Postal Addresses for the Contact |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Organization resource enables the user to retrieve the details of an organization.
HTTP Method
:
GET
Request URL
:
STU3/Organization
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | Identifies this organization across multiple systems |
| Active | boolean | Whether the organization's record is still in active use |
| type | CodeableConcept | Kind of organization |
| name | String | Name used for the organization |
| alias | String | A list of alternate names that the organization is known as, or was known as in the past |
| telecom | ContactPoint | A contact detail for the organization |
| address | Address | An address for the organization |
| partOf | Reference(Organization) | The organization of which this organization forms a part |
| Addressed | Address | Patient Permanent address |
| Contact | BackboneElement | Contact for the organization for a certain purpose |
| Purpose | CodeableConcept | The type of contact |
| Name | HumanName | A name associated with the contact |
| telecom | ContactPoint | Contact details for a Contact |
| Address | Address | Visting or Postal Addresses for the Contact |
EXF-FHIR Organization resource enables the user to retrieve the required details of an organization based on the search parameters like identifiers, name, type, address, etc.
HTTP Method
:
GET
Request URL
:
STU3/Organization
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| active | Token | Organization.active |
| address-city | String | Organization.address.city |
| address-country | String | Organization.address.postalCode |
| address-state | String | Organization.address.state |
| address-use | Token | Organization.address.use |
| Identifier | Token | Organization.identifier |
| Name | String | Organization.name | Organization.alias |
| Type | Token | Organization.type |
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | Identifies this organization across multiple systems |
| Active | boolean | Whether the organization's record is still in active use |
| type | CodeableConcept | Kind of organization |
| name | String | Name used for the organization |
| alias | String | A list of alternate names that the organization is known as, or was known as in the past |
| telecom | ContactPoint | A contact detail for the organization |
| address | Address | An address for the organization |
| partOf | Reference(Organization) | The organization of which this organization forms a part |
| Addressed | Address | Patient Permanent address |
| Contact | BackboneElement | Contact for the organization for a certain purpose |
| Purpose | CodeableConcept | The type of contact |
| Name | HumanName | A name associated with the contact |
| telecom | ContactPoint | Contact details for a Contact |
| Address | Address | Visting or Postal Addresses for the Contact |
EXF-FHIR Encounter resource is an interface between the patient and the healthcare Provider for the purpose of providing healthcare services to the patient or for evaluating health status of the patient.
HTTP Method
:
POST
Request URL
:
STU3/Encounter
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | Identifier(s) by which this encounter is known |
| Active | boolean | Whether this practitioner's record is in active use |
| Status | Code | planned | arrived | triaged | in-progress | onleave | finished | cancelled |
| statusHistory | BackboneElement | List of past encounter statuses |
| Class | Coding | inpatient | outpatient | ambulatory | emergency |
| ClassHistory | BackboneElement | List of past encounter classes |
| Type | CodeableConcept | Specific type of encounter |
| Priority | CodeableConcept | Indicates the urgency of the encounter |
| Qualification | BackboneElement | Qualifications obtained by training and certification |
| Subject | Reference(Patient|Group) | The patient ro group present at the encounter |
| episodeOfcare | Reference(EpisodeofCare) | Episode(s) of care that this encounter should be recorded against |
| Incomingrefferal | Reference(RefferalRequest) | The ReferralRequest that initiated this encounter |
| Participant | Backboneelement | List of participants involved in the encounter |
| Appointment | Reference(Appointment) | The appointment that scheduled this encounter |
| Diagnosis | Backboneelement | The list of diagnosis relevant to this encounter |
| Account | Reference(Account) | The set of accounts that may be used for billing for this Encounter |
| Hospitilization | Backboneelement | Details about the admission to a healthcare service |
| Location | Backboneelement | List of locations where the patient has been |
| serviceProvider | Reference(Organization) | The custodian organization of this Encounter record |
| part of | Reference(Encounter) | Another Encounter this encounter is part of |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Encounter resource enables the user to retrieve the patient healthcare details by using the unique identifier only.
HTTP Method
:
GET
Request URL
:
STU3/Encounter
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | Identifier(s) by which this encounter is known |
| Active | boolean | Whether this practitioner's record is in active use |
| Status | Code | planned | arrived | triaged | in-progress | onleave | finished | cancelled |
| statusHistory | BackboneElement | List of past encounter statuses |
| Class | Coding | inpatient | outpatient | ambulatory | emergency |
| ClassHistory | BackboneElement | List of past encounter classes |
| Type | CodeableConcept | Specific type of encounter |
| Priority | CodeableConcept | Indicates the urgency of the encounter |
| Qualification | BackboneElement | Qualifications obtained by training and certification |
| Subject | Reference(Patient|Group) | The patient ro group present at the encounter |
| episodeOfcare | Reference(EpisodeofCare) | Episode(s) of care that this encounter should be recorded against |
| Incomingrefferal | Reference(RefferalRequest) | The ReferralRequest that initiated this encounter |
| Participant | Backboneelement | List of participants involved in the encounter |
| Appointment | Reference(Appointment) | The appointment that scheduled this encounter |
| Diagnosis | Backboneelement | The list of diagnosis relevant to this encounter |
| Account | Reference(Account) | The set of accounts that may be used for billing for this Encounter |
| Hospitilization | Backboneelement | Details about the admission to a healthcare service |
| Location | Backboneelement | List of locations where the patient has been |
| serviceProvider | Reference(Organization) | The custodian organization of this Encounter record |
| part of | Reference(Encounter) | Another Encounter this encounter is part of |
EXF-FHIR Encounter resource enables the user to retrieve the required patient’s healthcare details based on the search parameters like name of the patient or participant, status, subject, location, etc.
HTTP Method
:
GET
Request URL
:
STU3/Encounter
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| participant | reference | Encounter.participant.individual |
| Patient | Reference | Encounter.subject |
| Status | Token | Encounter.status |
| subject | Reference | Encounter.subject |
| location | Reference | Encounter.location.location |
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | Identifier(s) by which this encounter is known |
| Active | boolean | Whether this practitioner's record is in active use |
| Status | Code | planned | arrived | triaged | in-progress | onleave | finished | cancelled |
| statusHistory | BackboneElement | List of past encounter statuses |
| Class | Coding | inpatient | outpatient | ambulatory | emergency |
| ClassHistory | BackboneElement | List of past encounter classes |
| Type | CodeableConcept | Specific type of encounter |
| Priority | CodeableConcept | Indicates the urgency of the encounter |
| Qualification | BackboneElement | Qualifications obtained by training and certification |
| Subject | Reference(Patient|Group) | The patient ro group present at the encounter |
| episodeOfcare | Reference(EpisodeofCare) | Episode(s) of care that this encounter should be recorded against |
| Incomingrefferal | Reference(RefferalRequest) | The ReferralRequest that initiated this encounter |
| Participant | Backboneelement | List of participants involved in the encounter |
| Appointment | Reference(Appointment) | The appointment that scheduled this encounter |
| Diagnosis | Backboneelement | The list of diagnosis relevant to this encounter |
| Account | Reference(Account) | The set of accounts that may be used for billing for this Encounter |
| Hospitilization | Backboneelement | Details about the admission to a healthcare service |
| Location | Backboneelement | List of locations where the patient has been |
| serviceProvider | Reference(Organization) | The custodian organization of this Encounter record |
| part of | Reference(Encounter) | Another Encounter this encounter is part of |
EXF-FHIR Practitioner resource enables the user to create Practitioner details of healthcare organizations with a unique identifier. Practitioner is a Healthcare Provider who can directly or indirectly involve in providing the healthcare services.
HTTP Method
:
POST
Request URL
:
STU3/Practitioner
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | A identifier for the person as this agent |
| Active | boolean | Whether this practitioner's record is in active use |
| name | HumanName | The name(s) associated with the practitioner |
| telecom | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | code | male | female | other | unknown |
| birthDate | Date | The date on which the practioner was born |
| photo | Attachment | Image of the person |
| qualification | BackboneElement | Qualifications obtained by training and certification |
| identifier | Identifier | An identifier for this qualification for the practitioner |
| code | CodeableConcept | Coded representation of the qualification |
| period | Period | Period during which the qualification is valid |
| issuer | Reference(Organization) | Organization that regulates and issues the qualification |
| Communication | Codeableconcept | A language the practitioner is able to use in patient communication |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Practitioner resource enables the user to retrieve the Practitioner details of a healthcare organization with the help of a unique identifier.
HTTP Method
:
GET
Request URL
:
STU3/Practitioner
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | A identifier for the person as this agent |
| Active | boolean | Whether this practitioner's record is in active use |
| name | HumanName | The name(s) associated with the practitioner |
| telecom | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | code | male | female | other | unknown |
| birthDate | Date | The date on which the practioner was born |
| photo | Attachment | Image of the person |
| qualification | BackboneElement | Qualifications obtained by training and certification |
| identifier | Identifier | An identifier for this qualification for the practitioner |
| code | CodeableConcept | Coded representation of the qualification |
| period | Period | Period during which the qualification is valid |
| issuer | Reference(Organization) | Organization that regulates and issues the qualification |
| Communication | Codeableconcept | A language the practitioner is able to use in patient communication |
EXF-FHIR Practitioner resource enables the user to retrieve the required details of Practitioners based on the search parameters like address, family, gender, etc.
HTTP Method
:
GET
Request URL
:
STU3/Practitioner
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| active | Token | Practitioner.active |
| address | String | Practitioner.address |
| family | String | Practitioner.name.family |
| gender | Token | Practitioner.gender |
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | A identifier for the person as this agent |
| Active | boolean | Whether this practitioner's record is in active use |
| name | HumanName | The name(s) associated with the practitioner |
| telecom | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | code | male | female | other | unknown |
| birthDate | Date | The date on which the practioner was born |
| photo | Attachment | Image of the person |
| qualification | BackboneElement | Qualifications obtained by training and certification |
| identifier | Identifier | An identifier for this qualification for the practitioner |
| code | CodeableConcept | Coded representation of the qualification |
| period | Period | Period during which the qualification is valid |
| issuer | Reference(Organization) | Organization that regulates and issues the qualification |
| Communication | Codeableconcept | A language the practitioner is able to use in patient communication |
EXF-FHIR Condition resource enables the user to create Condition details of the patient like Clinical status, Verification status, Category, Severity, etc.>/p>
HTTP Method
:
POST
Request URL
:
STU3/Condition
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | External Ids for this condition |
| Clinical Status | Code | active | recurrence | inactive | remission | resolved |
| Verification Status | Code | provisional | differential | confirmed | refuted | entered-in-error | unknown |
| Category | CodeableConcept | problem-list-item | encounter-diagnosis |
| Severity | CodeableConcept | Subjective severity of condition |
| Code | CodeableConcept | Identification of the condition, problem or diagnosis |
| Body Site | CodeableConcept | Anatomical location, if relevant |
| Subject | Reference (Patient | Group) | Who has the condition? |
| Context | Reference (Encounter | Episode of Care) | Encounter or episode when condition first asserted |
| Onset | Estimated or actual date, date-time, or age | |
| Onset DateTime | DateTime | |
| Onset Age | Age | |
| Onset Period | Period | |
| Onset Range | Range | |
| Onset String | String | |
| Abatement | If/when in resolution/remission | |
| Onset Range | Range | |
| Abatement DateTime | DateTime | |
| Abatement Age | Age | |
| Abatement Boolean | Boolean | |
| Abatement Period | Period | |
| Abatement Range | Range | |
| Abatement String | String | |
| Asserted date | DateTime | Date record was believed accurate |
| Asserter | Reference (Practitioner | Patient | Related Person) | Person who asserts this condition |
| Stage | Backbone Element | Stage/grade, usually assessed formally |
| Summary | CodeableConcept | Simple summary (disease specific) |
| Assessment | Reference (ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment |
| Evidence | Backbone Element | Supporting evidence |
| Code | CodeableConcept | Manifestation/symptom |
| Detail | Reference (Any) | Supporting information found elsewhere |
| Note | Annotation | Additional information about the Condition |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Condition resource enables the user to retrieve the Condition details of the patient like Clinical status, Verification status, Category, Severity, etc.
HTTP Method
:
GET
Request URL
:
STU3/Condition
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | External Ids for this condition |
| Clinical Status | Code | active | recurrence | inactive | remission | resolved |
| Verification Status | Code | provisional | differential | confirmed | refuted | entered-in-error | unknown |
| Category | CodeableConcept | problem-list-item | encounter-diagnosis |
| Severity | CodeableConcept | Subjective severity of condition |
| Code | CodeableConcept | Identification of the condition, problem or diagnosis |
| Body Site | CodeableConcept | Anatomical location, if relevant |
| Subject | Reference (Patient | Group) | Who has the condition? |
| Context | Reference (Encounter | Episode of Care) | Encounter or episode when condition first asserted |
| Onset | Estimated or actual date, date-time, or age | |
| Onset DateTime | DateTime | |
| Onset Age | Age | |
| Onset Period | Period | |
| Onset Range | Range | |
| Onset String | String | |
| Abatement | If/when in resolution/remission | |
| Onset Range | Range | |
| Abatement DateTime | DateTime | |
| Abatement Age | Age | |
| Abatement Boolean | Boolean | |
| Abatement Period | Period | |
| Abatement Range | Range | |
| Abatement String | String | |
| Asserted date | DateTime | Date record was believed accurate |
| Asserter | Reference (Practitioner | Patient | Related Person) | Person who asserts this condition |
| Stage | Backbone Element | Stage/grade, usually assessed formally |
| Summary | CodeableConcept | Simple summary (disease specific) |
| Assessment | Reference (ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment |
| Evidence | Backbone Element | Supporting evidence |
| Code | CodeableConcept | Manifestation/symptom |
| Detail | Reference (Any) | Supporting information found elsewhere |
| Note | Annotation | Additional information about the Condition |
EXF-FHIR Condition resource enables the user to retrieve the required Condition details of Patients based on the search parameters like code, context, encounter, evidence, identifiers, etc.
HTTP Method
:
GET
Request URL
:
STU3/Condition
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| code | token | Condition.code |
| context | reference | Condition.context |
| encounter | reference | Condition.context |
| evidence | token | Condition.evidence.code |
| evidence-detail | reference | Condition.evidence.detail |
| Identifier | token | Condition.identifier |
| onset-age | quantity | Condition.onset.as (Age) | Condition.onset.as (Range) |
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | External Ids for this condition |
| Clinical Status | Code | active | recurrence | inactive | remission | resolved |
| Verification Status | Code | provisional | differential | confirmed | refuted | entered-in-error | unknown |
| Category | CodeableConcept | problem-list-item | encounter-diagnosis |
| Severity | CodeableConcept | Subjective severity of condition |
| Code | CodeableConcept | Identification of the condition, problem or diagnosis |
| Body Site | CodeableConcept | Anatomical location, if relevant |
| Subject | Reference (Patient | Group) | Who has the condition? |
| Context | Reference (Encounter | Episode of Care) | Encounter or episode when condition first asserted |
| Onset | Estimated or actual date, date-time, or age | |
| Onset DateTime | DateTime | |
| Onset Age | Age | |
| Onset Period | Period | |
| Onset Range | Range | |
| Onset String | String | |
| Abatement | If/when in resolution/remission | |
| Onset Range | Range | |
| Abatement DateTime | DateTime | |
| Abatement Age | Age | |
| Abatement Boolean | Boolean | |
| Abatement Period | Period | |
| Abatement Range | Range | |
| Abatement String | String | |
| Asserted date | DateTime | Date record was believed accurate |
| Asserter | Reference (Practitioner | Patient | Related Person) | Person who asserts this condition |
| Stage | Backbone Element | Stage/grade, usually assessed formally |
| Summary | CodeableConcept | Simple summary (disease specific) |
| Assessment | Reference (ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment |
| Evidence | Backbone Element | Supporting evidence |
| Code | CodeableConcept | Manifestation/symptom |
| Detail | Reference (Any) | Supporting information found elsewhere |
| Note | Annotation | Additional information about the Condition |
EXF-FHIR Diagnostic Report resource enables the user to save the Diagnostic reports of a patient(s). It is inclusive of provider information, atomic results, images, textual & coded interpretations, and formatted representation of diagnostic reports.
HTTP Method
:
POST
Request URL
:
STU3/DiagnosticReport
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | Business identifier for report |
| basedOn | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested |
| status | code | registered | partial | preliminary | final |
| category | CodeableConcept | Service category |
| code | CodeableConcept | Name/Code for this diagnostic report |
| subject | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient |
| encounter | Reference(Encounter) | Health care event when test ordered |
| effectiveDateTime | dateTime | Clinically relevant time/time-period for report |
| effectivePeriod | Period | Clinically relevant time/time-period for report |
| issued | instant | DateTime this version was made |
| performer | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service |
| resultsInterpreter | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen | Reference(Specimen) | Specimens this report is based on |
| result | Reference(Observation) | Observations |
| imagingStudy | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report |
| media | BackboneElement | Key images associated with this report |
| comment | string | Comment about the image (e.g. explanation) |
| link | Reference(Media) | Reference to the image source |
| conclusion | string | Clinical conclusion (interpretation) of test results |
| conclusionCode | CodeableConcept | Codes for the clinical conclusion of test results |
| presentedForm | Attachment | Entire report as issued |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Diagnostic Report resource enables the user to retrieve the Diagnostic reports of a patient.
HTTP Method
:
GET
Request URL
:
STU3/DiagnosticReport
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | Business identifier for report |
| basedOn | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested |
| status | code | registered | partial | preliminary | final |
| category | CodeableConcept | Service category |
| code | CodeableConcept | Name/Code for this diagnostic report |
| subject | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient |
| encounter | Reference(Encounter) | Health care event when test ordered |
| effectiveDateTime | dateTime | Clinically relevant time/time-period for report |
| effectivePeriod | Period | Clinically relevant time/time-period for report |
| issued | instant | DateTime this version was made |
| performer | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service |
| resultsInterpreter | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen | Reference(Specimen) | Specimens this report is based on |
| result | Reference(Observation) | Observations |
| imagingStudy | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report |
| media | BackboneElement | Key images associated with this report |
| comment | string | Comment about the image (e.g. explanation) |
| link | Reference(Media) | Reference to the image source |
| conclusion | string | Clinical conclusion (interpretation) of test results |
| conclusionCode | CodeableConcept | Codes for the clinical conclusion of test results |
| presentedForm | Attachment | Entire report as issued |
EXF-FHIR Diagnostic Report resource enables the user to retrieve Diagnostic reports of patient(s) based on the search parameters like category, code, date, etc.
HTTP Method
:
GET
Request URL
:
STU3/DiagnosticReport
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| based-on | reference | DiagnosticReport.basedOn |
| category | token | DiagnosticReport.category |
| code | token | DiagnosticReport.code |
| conclusion | token | DiagnosticReport.conclusionCode |
| date | date | DiagnosticReport.effective |
| encounter | reference | DiagnosticReport.encounter |
| identifier | token | DiagnosticReport.identifier |
| issued | date | DiagnosticReport.issued |
| media | reference | DiagnosticReport.media.link |
| patient | reference | DiagnosticReport.subject.where(resolve() is Patient) |
| performer | reference | DiagnosticReport.performer |
| result | reference | DiagnosticReport.result |
| results-interpreter | reference | DiagnosticReport.resultsInterpreter |
| specimen | reference | DiagnosticReport.specimen |
| status | token | DiagnosticReport.status |
| subject | reference | DiagnosticReport.subject |
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | Business identifier for report |
| basedOn | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested |
| status | code | registered | partial | preliminary | final |
| category | CodeableConcept | Service category |
| code | CodeableConcept | Name/Code for this diagnostic report |
| subject | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient |
| encounter | Reference(Encounter) | Health care event when test ordered |
| effectiveDateTime | dateTime | Clinically relevant time/time-period for report |
| effectivePeriod | Period | Clinically relevant time/time-period for report |
| issued | instant | DateTime this version was made |
| performer | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service |
| resultsInterpreter | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen | Reference(Specimen) | Specimens this report is based on |
| result | Reference(Observation) | Observations |
| imagingStudy | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report |
| media | BackboneElement | Key images associated with this report |
| comment | string | Comment about the image (e.g. explanation) |
| link | Reference(Media) | Reference to the image source |
| conclusion | string | Clinical conclusion (interpretation) of test results |
| conclusionCode | CodeableConcept | Codes for the clinical conclusion of test results |
| presentedForm | Attachment | Entire report as issued |
EXF-FHIR Immunization resource enables the user to create the Immunization details of a patient. This resource also covers the vaccine administered and the details of the administration.
HTTP Method
:
POST
Request URL
:
STU3/Immunization
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | Business identifier |
| status | code | completed | entered-in-error |
| notGiven | boolean | Flag for whether immunization was given |
| vaccineCode | CodeableConcept | Vaccine product administered |
| patient | Reference(Patient) | Who was immunized |
| encounter | Reference(Encounter) | Encounter administered as part of |
| date | dateTime | Vaccination administration date |
| primarySource | boolean | Indicates context the data was recorded in |
| reportOrigin | CodeableConcept | Indicates the source of a secondarily reported record |
| location | Reference(Location) | Where vaccination occurred |
| manufacturer | Reference(Organization) | Vaccine manufacturer |
| lotNumber | string | Vaccine lot number |
| expirationDate | date | Vaccine expiration date |
| site | CodeableConcept | Body site vaccine was administered |
| route | CodeableConcept | How vaccine entered body |
| doseQuantity | SimpleQuantity | Amount of vaccine administered |
| practitioner | BackboneElement | Who performed event |
| role | CodeableConcept | What type of performance was done |
| actor | Reference(Practitioner) | Individual who was performing |
| note | Annotation | Vaccination notes |
| explanation | BackboneElement | Administration/non-administration reasons |
| reason | CodeableConcept | Why immunization occurred |
| reasonNotGiven | CodeableConcept | Why immunization did not occur |
| reaction | BackboneElement | Details of a reaction that follows immunization |
| date | dateTime | When reaction started |
| detail | Reference(Observation) | Additional information on reaction |
| reported | boolean | Indicates self-reported reaction |
| vaccinationProtocol | BackboneElement | What protocol was followed |
| doseSequence | positiveInt | Dose number within series |
| description | string | Details of vaccine protocol |
| authority | Reference(Organization) | Who is responsible for protocol |
| series | string | Name of vaccine series |
| explanation | BackboneElement | Administration/non-administration reasons |
| seriesDoses | positiveInt | Recommended number of doses for immunity |
| targetDisease | CodeableConcept | Disease immunized against |
| doseStatus | CodeableConcept | Indicates if dose counts towards immunity |
| doseStatusReason | CodeableConcept | Why dose does (not) count |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Immunization resource enables the user to retrieve the Immunization details of a patient.
HTTP Method
:
GET
Request URL
:
STU3/Immunization
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | Business identifier |
| status | code | completed | entered-in-error |
| notGiven | boolean | Flag for whether immunization was given |
| vaccineCode | CodeableConcept | Vaccine product administered |
| patient | Reference(Patient) | Who was immunized |
| encounter | Reference(Encounter) | Encounter administered as part of |
| date | dateTime | Vaccination administration date |
| primarySource | boolean | Indicates context the data was recorded in |
| reportOrigin | CodeableConcept | Indicates the source of a secondarily reported record |
| location | Reference(Location) | Where vaccination occurred |
| manufacturer | Reference(Organization) | Vaccine manufacturer |
| lotNumber | string | Vaccine lot number |
| expirationDate | date | Vaccine expiration date |
| site | CodeableConcept | Body site vaccine was administered |
| route | CodeableConcept | How vaccine entered body |
| doseQuantity | SimpleQuantity | Amount of vaccine administered |
| practitioner | BackboneElement | Who performed event |
| role | CodeableConcept | What type of performance was done |
| actor | Reference(Practitioner) | Individual who was performing |
| note | Annotation | Vaccination notes |
| explanation | BackboneElement | Administration/non-administration reasons |
| reason | CodeableConcept | Why immunization occurred |
| reasonNotGiven | CodeableConcept | Why immunization did not occur |
| reaction | BackboneElement | Details of a reaction that follows immunization |
| date | dateTime | When reaction started |
| detail | Reference(Observation) | Additional information on reaction |
| reported | boolean | Indicates self-reported reaction |
| vaccinationProtocol | BackboneElement | What protocol was followed |
| doseSequence | positiveInt | Dose number within series |
| description | string | Details of vaccine protocol |
| authority | Reference(Organization) | Who is responsible for protocol |
| series | string | Name of vaccine series |
| explanation | BackboneElement | Administration/non-administration reasons |
| seriesDoses | positiveInt | Recommended number of doses for immunity |
| targetDisease | CodeableConcept | Disease immunized against |
| doseStatus | CodeableConcept | Indicates if dose counts towards immunity |
| doseStatusReason | CodeableConcept | Why dose does (not) count |
EXF-FHIR Immunization resource enables the user to retrieve the required Immunization details of a patient(s) based on the search parameters like unique identifiers, location, references to patient and practitioner, etc.
HTTP Method
:
GET
Request URL
:
STU3/Immunization
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| date | date | Immunization.date |
| identifier | token | Immunization.identifier |
| location | reference | Immunization.location |
| lot-number | string | Immunization.lotNumber |
| manufacturer | reference | Immunization.manufacturer |
| notgiven | token | Immunization.notGiven |
| patient | reference | Immunization.patient |
| practitioner | reference | Immunization.practitioner.actor |
| reaction | reference | Immunization.reaction.detail |
| reaction-date | date | Immunization.reaction.date |
| reason | token | Immunization.explanation.reason |
| reason-not-given | token | Immunization.explanation.reasonNotGiven |
| status | token | Immunization.status |
| vaccine-code | token | Immunization.vaccineCode |
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | Business identifier |
| status | code | completed | entered-in-error |
| notGiven | boolean | Flag for whether immunization was given |
| vaccineCode | CodeableConcept | Vaccine product administered |
| patient | Reference(Patient) | Who was immunized |
| encounter | Reference(Encounter) | Encounter administered as part of |
| date | dateTime | Vaccination administration date |
| primarySource | boolean | Indicates context the data was recorded in |
| reportOrigin | CodeableConcept | Indicates the source of a secondarily reported record |
| location | Reference(Location) | Where vaccination occurred |
| manufacturer | Reference(Organization) | Vaccine manufacturer |
| lotNumber | string | Vaccine lot number |
| expirationDate | date | Vaccine expiration date |
| site | CodeableConcept | Body site vaccine was administered |
| route | CodeableConcept | How vaccine entered body |
| doseQuantity | SimpleQuantity | Amount of vaccine administered |
| practitioner | BackboneElement | Who performed event |
| role | CodeableConcept | What type of performance was done |
| actor | Reference(Practitioner) | Individual who was performing |
| note | Annotation | Vaccination notes |
| explanation | BackboneElement | Administration/non-administration reasons |
| reason | CodeableConcept | Why immunization occurred |
| reasonNotGiven | CodeableConcept | Why immunization did not occur |
| reaction | BackboneElement | Details of a reaction that follows immunization |
| date | dateTime | When reaction started |
| detail | Reference(Observation) | Additional information on reaction |
| reported | boolean | Indicates self-reported reaction |
| vaccinationProtocol | BackboneElement | What protocol was followed |
| doseSequence | positiveInt | Dose number within series |
| description | string | Details of vaccine protocol |
| authority | Reference(Organization) | Who is responsible for protocol |
| series | string | Name of vaccine series |
| explanation | BackboneElement | Administration/non-administration reasons |
| seriesDoses | positiveInt | Recommended number of doses for immunity |
| targetDisease | CodeableConcept | Disease immunized against |
| doseStatus | CodeableConcept | Indicates if dose counts towards immunity |
| doseStatusReason | CodeableConcept | Why dose does (not) count |
EXF-FHIR Medication Request resource enables the user to create Medication Request details of a patient. Medication Request describes the detailed information of an order or request for supply of the medication and instructions for administration of the medication to a patient. This Medication Request resource is not specific to any patient.
HTTP Method
:
POST
Request URL
:
STU3/MedicationRequest
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | External ids for this request |
| Definition | Reference (Activity Definition | Plan Definition) | Protocol or definition |
| BasedOn | Reference (Careplan | Medication request | Procedure request | Referral request) | What request fulfils |
| Group Identifier | Identifier | Composite request this is part of |
| Status | Code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown |
| Intent | Code | proposal | plan | order | instance-order |
| Category | CodeableConcept | Type of medication usage |
| Priority | Code | routine | urgent | stat | asap |
| Medication | BackboneElement | Medication to be taken |
| Medication Codeable Concept | CodeableConcept | |
| Medication Reference | Reference (Medication) | |
| Subject | Reference (Patient | Group) | Who or group medication request is for |
| Context | Reference (Encounter | Episode of Care) | Created during encounter/admission/stay |
| Supporting Information | Reference (Any) | Information to support ordering of the medication |
| Authored On | Date Time | When request was initially authored |
| Requester | Backbone Element | Who/What requested the Request |
| Agent | Reference (Practitioner | Organization | Patient | Related Person | Device) | Who ordered the initial medication |
| On Behalf Of | Reference (Organization) | Organization agent is acting for |
| Recorder | Reference (Practitioner) | Person who entered the request |
| Reason Code | CodeableConcept | Reason or indication for writing the prescription |
| Reason Reference | Reference (Condition | Observation) | Condition or Observation that supports why the prescription is being written |
| Note | Annotation | Information about the prescription |
| Dosage Instruction | Dosage | How the medication should be taken |
| Dispense request | Backbone Element | Medication supply authorization |
| Validity Period | Period | Time period supply is authorized for |
| Number Of Repeats Allowed | Integer | Number of refills authorized |
| Quantity | Simple quantity | Amount of medication to supply per dispense |
| Expected Supply Duration | Duration | Number of days supply per dispense |
| Performer | Reference (Organization) | Intended dispenser |
| Substitution | Backbone Element | Any restrictions on medication substitution |
| Allowed | Boolean | Whether substitution is allowed or not |
| Reason | Codeable concept | Why should (not) substitution be made |
| Prior Prescription | Reference (Medication request) | An order/prescription that is being replaced |
| Detected Issue | Reference (Detected issue) | Clinical Issue with action |
| Event history | Reference (Provenance) | A list of events of interest in the lifecycle |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Medication Request resource enables the user to retrieve the Medication Request details of a patient.
HTTP Method
:
GET
Request URL
:
STU3/MedicationRequest
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | External ids for this request |
| Definition | Reference (Activity Definition | Plan Definition) | Protocol or definition |
| BasedOn | Reference (Careplan | Medication request | Procedure request | Referral request) | What request fulfils |
| Group Identifier | Identifier | Composite request this is part of |
| Status | Code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown |
| Intent | Code | proposal | plan | order | instance-order |
| Category | CodeableConcept | Type of medication usage |
| Priority | Code | routine | urgent | stat | asap |
| Medication | BackboneElement | Medication to be taken |
| Medication Codeable Concept | CodeableConcept | |
| Medication Reference | Reference (Medication) | |
| Subject | Reference (Patient | Group) | Who or group medication request is for |
| Context | Reference (Encounter | Episode of Care) | Created during encounter/admission/stay |
| Supporting Information | Reference (Any) | Information to support ordering of the medication |
| Authored On | Date Time | When request was initially authored |
| Requester | Backbone Element | Who/What requested the Request |
| Agent | Reference (Practitioner | Organization | Patient | Related Person | Device) | Who ordered the initial medication |
| On Behalf Of | Reference (Organization) | Organization agent is acting for |
| Recorder | Reference (Practitioner) | Person who entered the request |
| Reason Code | CodeableConcept | Reason or indication for writing the prescription |
| Reason Reference | Reference (Condition | Observation) | Condition or Observation that supports why the prescription is being written |
| Note | Annotation | Information about the prescription |
| Dosage Instruction | Dosage | How the medication should be taken |
| Dispense request | Backbone Element | Medication supply authorization |
| Validity Period | Period | Time period supply is authorized for |
| Number Of Repeats Allowed | Integer | Number of refills authorized |
| Quantity | Simple quantity | Amount of medication to supply per dispense |
| Expected Supply Duration | Duration | Number of days supply per dispense |
| Performer | Reference (Organization) | Intended dispenser |
| Substitution | Backbone Element | Any restrictions on medication substitution |
| Allowed | Boolean | Whether substitution is allowed or not |
| Reason | Codeable concept | Why should (not) substitution be made |
| Prior Prescription | Reference (Medication request) | An order/prescription that is being replaced |
| Detected Issue | Reference (Detected issue) | Clinical Issue with action |
| Event history | Reference (Provenance) | A list of events of interest in the lifecycle |
EXF-FHIR Medication Request resource enables the user to retrieve the required Medication Request details of a patient based on the search parameters like Category, code, context, identifier, intent, etc.
HTTP Method
:
GET
Request URL
:
STU3/MedicationRequest
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| authoredon | date | MedicationRequest.authoredOn |
| category | token | MedicationRequest.category |
| Code | token | MedicationRequest.medication.as |
| Context | Reference | MedicationRequest.context |
| Date | date | MedicationRequest.dosageInstruction.timing.event |
| Identifier | token | MedicationRequest.identifier |
| intent | token | MedicationRequest.intent |
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | External ids for this request |
| Definition | Reference (Activity Definition | Plan Definition) | Protocol or definition |
| BasedOn | Reference (Careplan | Medication request | Procedure request | Referral request) | What request fulfils |
| Group Identifier | Identifier | Composite request this is part of |
| Status | Code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown |
| Intent | Code | proposal | plan | order | instance-order |
| Category | CodeableConcept | Type of medication usage |
| Priority | Code | routine | urgent | stat | asap |
| Medication | BackboneElement | Medication to be taken |
| Medication Codeable Concept | CodeableConcept | |
| Medication Reference | Reference (Medication) | |
| Subject | Reference (Patient | Group) | Who or group medication request is for |
| Context | Reference (Encounter | Episode of Care) | Created during encounter/admission/stay |
| Supporting Information | Reference (Any) | Information to support ordering of the medication |
| Authored On | Date Time | When request was initially authored |
| Requester | Backbone Element | Who/What requested the Request |
| Agent | Reference (Practitioner | Organization | Patient | Related Person | Device) | Who ordered the initial medication |
| On Behalf Of | Reference (Organization) | Organization agent is acting for |
| Recorder | Reference (Practitioner) | Person who entered the request |
| Reason Code | CodeableConcept | Reason or indication for writing the prescription |
| Reason Reference | Reference (Condition | Observation) | Condition or Observation that supports why the prescription is being written |
| Note | Annotation | Information about the prescription |
| Dosage Instruction | Dosage | How the medication should be taken |
| Dispense request | Backbone Element | Medication supply authorization |
| Validity Period | Period | Time period supply is authorized for |
| Number Of Repeats Allowed | Integer | Number of refills authorized |
| Quantity | Simple quantity | Amount of medication to supply per dispense |
| Expected Supply Duration | Duration | Number of days supply per dispense |
| Performer | Reference (Organization) | Intended dispenser |
| Substitution | Backbone Element | Any restrictions on medication substitution |
| Allowed | Boolean | Whether substitution is allowed or not |
| Reason | Codeable concept | Why should (not) substitution be made |
| Prior Prescription | Reference (Medication request) | An order/prescription that is being replaced |
| Detected Issue | Reference (Detected issue) | Clinical Issue with action |
| Event history | Reference (Provenance) | A list of events of interest in the lifecycle |
EXF-FHIR Observation resource enables the user to create the detailed information about a measurement or a simple assertion made about a patient or a device.
HTTP Method
:
POST
Request URL
:
STU3/Observation
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | Business Identifier for observation |
| basedOn | Reference | Fulfils plan, proposal or order |
| Status | Code | Observation Status |
| Category | CodeableConcept | Classification of type of Observation |
| Code | CodeableConcept | Type of observation (code / type) as, or was known as in the past |
| Subject | Reference (Patient | Group | Device | Location) | Who and/or What this is about |
| Context | Reference (Encounter | Episode of Care) | Healthcare event during which this observation is made |
| EffectiveDateTime | DateTime | Clinically relevant time for observation |
| EffectivePeriod | Period | Clinically relevant time-period for observation |
| Issued | instant | Date/Time this was made available |
| Performer | Reference (Practitioner | Organization | Patient | Related Person) | Who is responsible for the observation |
| Value | Actual Result | |
| Value Quantity | Quantity | |
| Value CodeableConcept | CodeableConcept | |
| Value String | String | |
| Value Boolean | Boolean | |
| Value Range | Range | |
| Value Ratio | Ratio | |
| Value Sampled data | Sampled data | |
| Value Attachment | Attachment | |
| Value Time | Time | |
| Value DateTime | DateTime | |
| Value Period | Period | |
| Data Absent Reason | CodeableConcept | Why the result is missing |
| Interpretation | CodeableConcept | High, low, normal, etc. |
| Comment | String | Comments about result |
| Body Site | CodeableConcept | Observed body part |
| Method | CodeableConcept | How it was done |
| Specimen | Reference (Specimen) | Specimen used for this observation |
| Device | Reference (Device | Device metric) | (Measurement) Device |
| Reference Range | Backbone Element | Provides guide for interpretation |
| Low | Simple quantity | Low Range, if relevant |
| Reference Range | Backbone Element | Provides guide for interpretation |
| High | Simple quantity | High Range, if relevant |
| Type | CodeableConcept | Reference range qualifier |
| Applies to | CodeableConcept | Reference range population |
| Age | Range | Applicable age range, if relevant |
| Text | String | Text based reference range in an observation |
| Related | Backbone Element | Resource related to this observation |
| Type | Code | |
| Target | Reference (Observation | Questionnaire Response | Sequence) | Resource that is related to this one |
| Component | Backbone Element | Component Results |
| Code | CodeableConcept | Type of component observation (code / type) |
| Value | Actual Result | |
| Value Quantity | Quantity | |
| Value CodeableConcept | CodeableConcept | |
| Value String | String | |
| Value Range | Range | |
| Value Ratio | Ratio | |
| Value Sampled data | Sampled data | |
| Value Attachment | Attachment | |
| Value Time | Time | |
| Value DateTime | DateTime | |
| Value Period | Period | |
| Data Absent Reason | CodeableConcept | Why the Component result is missing |
| Interpretation | CodeableConcept | High, low, normal, etc. |
| Reference Range | Backbone Element | Provides guide for interpretation of Component result |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Observation resource enables the user to retrieve the detailed information about a measurement or a simple assertion made about a patient or a device.
HTTP Method
:
GET
Request URL
:
STU3/Observation
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | Business Identifier for observation |
| basedOn | Reference | Fulfils plan, proposal or order |
| Status | Code | Observation Status |
| Category | CodeableConcept | Classification of type of Observation |
| Code | CodeableConcept | Type of observation (code / type) as, or was known as in the past |
| Subject | Reference (Patient | Group | Device | Location) | Who and/or What this is about |
| Context | Reference (Encounter | Episode of Care) | Healthcare event during which this observation is made |
| EffectiveDateTime | DateTime | Clinically relevant time for observation |
| EffectivePeriod | Period | Clinically relevant time-period for observation |
| Issued | instant | Date/Time this was made available |
| Performer | Reference (Practitioner | Organization | Patient | Related Person) | Who is responsible for the observation |
| Value | Actual Result | |
| Value Quantity | Quantity | |
| Value CodeableConcept | CodeableConcept | |
| Value String | String | |
| Value Boolean | Boolean | |
| Value Range | Range | |
| Value Ratio | Ratio | |
| Value Sampled data | Sampled data | |
| Value Attachment | Attachment | |
| Value Time | Time | |
| Value DateTime | DateTime | |
| Value Period | Period | |
| Data Absent Reason | CodeableConcept | Why the result is missing |
| Interpretation | CodeableConcept | High, low, normal, etc. |
| Comment | String | Comments about result |
| Body Site | CodeableConcept | Observed body part |
| Method | CodeableConcept | How it was done |
| Specimen | Reference (Specimen) | Specimen used for this observation |
| Device | Reference (Device | Device metric) | (Measurement) Device |
| Reference Range | Backbone Element | Provides guide for interpretation |
| Low | Simple quantity | Low Range, if relevant |
| Reference Range | Backbone Element | Provides guide for interpretation |
| High | Simple quantity | High Range, if relevant |
| Type | CodeableConcept | Reference range qualifier |
| Applies to | CodeableConcept | Reference range population |
| Age | Range | Applicable age range, if relevant |
| Text | String | Text based reference range in an observation |
| Related | Backbone Element | Resource related to this observation |
| Type | Code | |
| Target | Reference (Observation | Questionnaire Response | Sequence) | Resource that is related to this one |
| Component | Backbone Element | Component Results |
| Code | CodeableConcept | Type of component observation (code / type) |
| Value | Actual Result | |
| Value Quantity | Quantity | |
| Value CodeableConcept | CodeableConcept | |
| Value String | String | |
| Value Range | Range | |
| Value Ratio | Ratio | |
| Value Sampled data | Sampled data | |
| Value Attachment | Attachment | |
| Value Time | Time | |
| Value DateTime | DateTime | |
| Value Period | Period | |
| Data Absent Reason | CodeableConcept | Why the Component result is missing |
| Interpretation | CodeableConcept | High, low, normal, etc. |
| Reference Range | Backbone Element | Provides guide for interpretation of Component result |
EXF-FHIR Observation resource enables the user to retrieve the required Observation details made about a patient or a device based on the search parameters like Category, Code, Context, Data-Absent reason, Encounter, etc.
HTTP Method
:
GET
Request URL
:
STU3/Observation
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| based-on | reference | Observation.basedOn |
| category | CodeableConcept | Observation.category |
| code | CodeableConcept | Observation.code |
| Context | Reference (Encounter | Episode of Care) | v |
| Data-Absent-reason | Token | Observation.dataAbsentReason |
| Date | Date | Observation.effective |
| encounter | Reference | Observation.context |
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | Business Identifier for observation |
| basedOn | Reference | Fulfils plan, proposal or order |
| Status | Code | Observation Status |
| Category | CodeableConcept | Classification of type of Observation |
| Code | CodeableConcept | Type of observation (code / type) as, or was known as in the past |
| Subject | Reference (Patient | Group | Device | Location) | Who and/or What this is about |
| Context | Reference (Encounter | Episode of Care) | Healthcare event during which this observation is made |
| EffectiveDateTime | DateTime | Clinically relevant time for observation |
| EffectivePeriod | Period | Clinically relevant time-period for observation |
| Issued | instant | Date/Time this was made available |
| Performer | Reference (Practitioner | Organization | Patient | Related Person) | Who is responsible for the observation |
| Value | Actual Result | |
| Value Quantity | Quantity | |
| Value CodeableConcept | CodeableConcept | |
| Value String | String | |
| Value Boolean | Boolean | |
| Value Range | Range | |
| Value Ratio | Ratio | |
| Value Sampled data | Sampled data | |
| Value Attachment | Attachment | |
| Value Time | Time | |
| Value DateTime | DateTime | |
| Value Period | Period | |
| Data Absent Reason | CodeableConcept | Why the result is missing |
| Interpretation | CodeableConcept | High, low, normal, etc. |
| Comment | String | Comments about result |
| Body Site | CodeableConcept | Observed body part |
| Method | CodeableConcept | How it was done |
| Specimen | Reference (Specimen) | Specimen used for this observation |
| Device | Reference (Device | Device metric) | (Measurement) Device |
| Reference Range | Backbone Element | Provides guide for interpretation |
| Low | Simple quantity | Low Range, if relevant |
| Reference Range | Backbone Element | Provides guide for interpretation |
| High | Simple quantity | High Range, if relevant |
| Type | CodeableConcept | Reference range qualifier |
| Applies to | CodeableConcept | Reference range population |
| Age | Range | Applicable age range, if relevant |
| Text | String | Text based reference range in an observation |
| Related | Backbone Element | Resource related to this observation |
| Type | Code | |
| Target | Reference (Observation | Questionnaire Response | Sequence) | Resource that is related to this one |
| Component | Backbone Element | Component Results |
| Code | CodeableConcept | Type of component observation (code / type) |
| Value | Actual Result | |
| Value Quantity | Quantity | |
| Value CodeableConcept | CodeableConcept | |
| Value String | String | |
| Value Range | Range | |
| Value Ratio | Ratio | |
| Value Sampled data | Sampled data | |
| Value Attachment | Attachment | |
| Value Time | Time | |
| Value DateTime | DateTime | |
| Value Period | Period | |
| Data Absent Reason | CodeableConcept | Why the Component result is missing |
| Interpretation | CodeableConcept | High, low, normal, etc. |
| Reference Range | Backbone Element | Provides guide for interpretation of Component result |
EXF-FHIR Claim resource enables the user to create claim details like the issued list of professional services and products which have been provided, or are to be provided, to a patient that is sent to an insurer for reimbursement.
HTTP Method
:
POST
Request URL
:
STU3/Claim
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | Claim number |
| Status | Code | active | cancelled | draft | entered-in-error |
| Type | CodeableConcept | Type or discipline |
| Subtype | CodeableConcept | Finer grained claim type information |
| Use | Code | complete | proposed | exploratory | other |
| Patient | Reference(Patient) | The subject of the Products and Services |
| BillablePeriod | Period | Period for charge submission |
| Created | dateTime | Creation date |
| Enterer | Reference(Practitioner) | Author |
| Insurer | Reference(Organization) | Target |
| Provider | Reference(Practitioner) | Responsible provider |
| Organization | Reference(Organization) | Responsible organization |
| Priority | CodeableConcept | Specimens this report is based on |
| Funds Reserve | CodeableConcept | Funds requested to be reserved |
| Related | BackboneElement | Related Claims which may be relevant to processing this claim |
| Claim | Reference(Claim) | Reference to the related claim |
| Relationship | CodeableConcept | How the reference claim is related |
| Reference | Identifier | Related file or case reference |
| prescription | Reference(MedicationRequest | VisionPrescription) | Prescription authorizing services or products |
| originalPrescription | Reference(MedicationRequest) | Original prescription if superceded by fulfiller |
| payee | BackboneElement | Party to be paid any benefits payable |
| type | CodeableConcept | Type of party: Subscriber, Provider, other |
| resourceType | Coding | organization | patient | practitioner | relatedperson |
| party | Reference(Practitioner | Organization | Patient | RelatedPerson) | Party to receive the payable |
| referral | Reference(ReferralRequest) | Treatment Referral |
| facility | Reference(Location) | Servicing Facility |
| careTeam | BackboneElement | Members of the care team |
| sequence | positiveInt | Number to covey order of careTeam |
| provider | Reference(Practitioner | Organization) | Provider individual or organization |
| responsible | boolean | Billing provider |
| role | CodeableConcept | Role on the team |
| qualification | CodeableConcept | Type, classification or Specialization |
| information | BackboneElement | Exceptions, special considerations, the condition, situation, prior or concurrent issues |
| sequence | positiveInt | Information instance identifier |
| category | CodeableConcept | General class of information |
| code | CodeableConcept | Type of information |
| timingDate | date | When it occurred |
| timingPeriod | Period | When it occurred |
| valueString | string | Additional Data or supporting information |
| valueQuantity | Quantity | Additional Data or supporting information |
| valueAttachment | Attachment | Additional Data or supporting information |
| valueReference | Reference(Any) | Additional Data or supporting information |
| reason | CodeableConcept | Reason associated with the information |
| diagnosis | BackboneElement | List of Diagnosis |
| sequence | positiveInt | Number to covey order of diagnosis |
| diagnosisCodeableConcept | CodeableConcept | Patient's diagnosis |
| diagnosisReference | Reference(Condition) | Patient's diagnosis |
| type | CodeableConcept | Timing or nature of the diagnosis |
| packageCode | CodeableConcept | Package billing code |
| procedure | BackboneElement | Procedures performed |
| sequence | positiveInt | Procedure sequence for reference |
| date | dateTime | When the procedure was performed |
| procedureCodeableConcept | CodeableConcept | Patient's list of procedures performed |
| procedureReference | Reference(Procedure) | Patient's list of procedures performed |
| insurance | BackboneElement | Insurance or medical plan |
| sequence | positiveInt | Service instance identifier |
| focal | boolean | Is the focal Coverage |
| coverage | Reference(Coverage) | Insurance information |
| businessArrangement | string | Business agreement |
| preAuthRef | string | Pre-Authorization/Determination Reference |
| claimResponse | Reference(ClaimResponse) | Adjudication results |
| accident | BackboneElement | Details about an accident |
| date | date | When the accident occurred see information codes see information codes |
| type | CodeableConcept | The nature of the accident |
| locationAddress | Address | Accident Place |
| locationReference | Reference(Location) | Accident Place |
| employmentImpacted | Period | Period unable to work |
| hospitalization | Period | Period in hospital |
| item | BackboneElement | Goods and Services |
| sequence | positiveInt | Service instance |
| careTeamLinkId | positiveInt | Applicable careTeam members |
| diagnosisLinkId | positiveInt | Applicable diagnoses |
| procedureLinkId | positiveInt | Applicable procedures |
| informationLinkId | positiveInt | Applicable exception and supporting information |
| revenue | CodeableConcept | Revenue or cost center code |
| category | CodeableConcept | Type of service or product |
| service | CodeableConcept | Billing Code |
| modifier | CodeableConcept | Service/Product billing modifiers |
| programCode | CodeableConcept | Program specific reason for item inclusion |
| servicedDate | date | Date or dates of Service |
| servicedPeriod | Period | Date or dates of Service |
| locationCodeableConcept | CodeableConcept | Place of service |
| locationAddress | Address | Place of service |
| locationReference | Reference(Location) | Place of service |
| quantity | SimpleQuantity | Count of Products or Services |
| unitPrice | Money | Fee, charge or cost per point |
| factor | decimal | Price scaling factor |
| net | Money | Total item cost |
| udi | Reference(Device) | Unique Device Identifier |
| bodySite | CodeableConcept | Service Location |
| subSite | CodeableConcept | Service Sub-location |
| encounter | Reference(Encounter) | Encounters related to this billed item |
| detail | BackboneElement | Additional items |
| sequence | positiveInt | Service instance |
| revenue | CodeableConcept | Revenue or cost center code |
| category | CodeableConcept | Type of service or product |
| service | CodeableConcept | Billing Code |
| modifier | CodeableConcept | Service/Product billing modifiers |
| programCode | CodeableConcept | Program specific reason for item inclusion |
| quantity | SimpleQuantity | Count of Products or Services |
| unitPrice | Money | Fee, charge or cost per point |
| factor | decimal | Price scaling factor |
| net | Money | Total additional item cost |
| udi | Reference(Device) | Unique Device Identifier |
| subDetail | BackboneElement | Additional items |
| sequence | positiveInt | Service instance |
| revenue | CodeableConcept | Revenue or cost center code |
| category | CodeableConcept | Type of service or product |
| service | CodeableConcept | Billing Code |
| modifier | CodeableConcept | Service/Product billing modifiers |
| programCode | CodeableConcept | Program specific reason for item inclusion |
| quantity | SimpleQuantity | Count of Products or Services |
| unitPrice | Money | Fee, charge or cost per point |
| factor | decimal | Price scaling factor |
| net | Money | Net additional item cost |
| udi | Reference(Device) | Unique Device Identifier |
| total | Money | Total claim cost |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Claim resource enables the user to retrieve the claim details.
HTTP Method
:
GET
Request URL
:
STU3/Claim
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | Claim number |
| Status | Code | active | cancelled | draft | entered-in-error |
| Type | CodeableConcept | Type or discipline |
| Subtype | CodeableConcept | Finer grained claim type information |
| Use | Code | complete | proposed | exploratory | other |
| Patient | Reference(Patient) | The subject of the Products and Services |
| BillablePeriod | Period | Period for charge submission |
| Created | dateTime | Creation date |
| Enterer | Reference(Practitioner) | Author |
| Insurer | Reference(Organization) | Target |
| Provider | Reference(Practitioner) | Responsible provider |
| Organization | Reference(Organization) | Responsible organization |
| Priority | CodeableConcept | Specimens this report is based on |
| Funds Reserve | CodeableConcept | Funds requested to be reserved |
| Related | BackboneElement | Related Claims which may be relevant to processing this claim |
| Claim | Reference(Claim) | Reference to the related claim |
| Relationship | CodeableConcept | How the reference claim is related |
| Reference | Identifier | Related file or case reference |
| prescription | Reference(MedicationRequest | VisionPrescription) | Prescription authorizing services or products |
| originalPrescription | Reference(MedicationRequest) | Original prescription if superceded by fulfiller |
| payee | BackboneElement | Party to be paid any benefits payable |
| type | CodeableConcept | Type of party: Subscriber, Provider, other |
| resourceType | Coding | organization | patient | practitioner | relatedperson |
| party | Reference(Practitioner | Organization | Patient | RelatedPerson) | Party to receive the payable |
| referral | Reference(ReferralRequest) | Treatment Referral |
| facility | Reference(Location) | Servicing Facility |
| careTeam | BackboneElement | Members of the care team |
| sequence | positiveInt | Number to covey order of careTeam |
| provider | Reference(Practitioner | Organization) | Provider individual or organization |
| responsible | boolean | Billing provider |
| role | CodeableConcept | Role on the team |
| qualification | CodeableConcept | Type, classification or Specialization |
| information | BackboneElement | Exceptions, special considerations, the condition, situation, prior or concurrent issues |
| sequence | positiveInt | Information instance identifier |
| category | CodeableConcept | General class of information |
| code | CodeableConcept | Type of information |
| timingDate | date | When it occurred |
| timingPeriod | Period | When it occurred |
| valueString | string | Additional Data or supporting information |
| valueQuantity | Quantity | Additional Data or supporting information |
| valueAttachment | Attachment | Additional Data or supporting information |
| valueReference | Reference(Any) | Additional Data or supporting information |
| reason | CodeableConcept | Reason associated with the information |
| diagnosis | BackboneElement | List of Diagnosis |
| sequence | positiveInt | Number to covey order of diagnosis |
| diagnosisCodeableConcept | CodeableConcept | Patient's diagnosis |
| diagnosisReference | Reference(Condition) | Patient's diagnosis |
| type | CodeableConcept | Timing or nature of the diagnosis |
| packageCode | CodeableConcept | Package billing code |
| procedure | BackboneElement | Procedures performed |
| sequence | positiveInt | Procedure sequence for reference |
| date | dateTime | When the procedure was performed |
| procedureCodeableConcept | CodeableConcept | Patient's list of procedures performed |
| procedureReference | Reference(Procedure) | Patient's list of procedures performed |
| insurance | BackboneElement | Insurance or medical plan |
| sequence | positiveInt | Service instance identifier |
| focal | boolean | Is the focal Coverage |
| coverage | Reference(Coverage) | Insurance information |
| businessArrangement | string | Business agreement |
| preAuthRef | string | Pre-Authorization/Determination Reference |
| claimResponse | Reference(ClaimResponse) | Adjudication results |
| accident | BackboneElement | Details about an accident |
| date | date | When the accident occurred see information codes see information codes |
| type | CodeableConcept | The nature of the accident |
| locationAddress | Address | Accident Place |
| locationReference | Reference(Location) | Accident Place |
| employmentImpacted | Period | Period unable to work |
| hospitalization | Period | Period in hospital |
| item | BackboneElement | Goods and Services |
| sequence | positiveInt | Service instance |
| careTeamLinkId | positiveInt | Applicable careTeam members |
| diagnosisLinkId | positiveInt | Applicable diagnoses |
| procedureLinkId | positiveInt | Applicable procedures |
| informationLinkId | positiveInt | Applicable exception and supporting information |
| revenue | CodeableConcept | Revenue or cost center code |
| category | CodeableConcept | Type of service or product |
| service | CodeableConcept | Billing Code |
| modifier | CodeableConcept | Service/Product billing modifiers |
| programCode | CodeableConcept | Program specific reason for item inclusion |
| servicedDate | date | Date or dates of Service |
| servicedPeriod | Period | Date or dates of Service |
| locationCodeableConcept | CodeableConcept | Place of service |
| locationAddress | Address | Place of service |
| locationReference | Reference(Location) | Place of service |
| quantity | SimpleQuantity | Count of Products or Services |
| unitPrice | Money | Fee, charge or cost per point |
| factor | decimal | Price scaling factor |
| net | Money | Total item cost |
| udi | Reference(Device) | Unique Device Identifier |
| bodySite | CodeableConcept | Service Location |
| subSite | CodeableConcept | Service Sub-location |
| encounter | Reference(Encounter) | Encounters related to this billed item |
| detail | BackboneElement | Additional items |
| sequence | positiveInt | Service instance |
| revenue | CodeableConcept | Revenue or cost center code |
| category | CodeableConcept | Type of service or product |
| service | CodeableConcept | Billing Code |
| modifier | CodeableConcept | Service/Product billing modifiers |
| programCode | CodeableConcept | Program specific reason for item inclusion |
| quantity | SimpleQuantity | Count of Products or Services |
| unitPrice | Money | Fee, charge or cost per point |
| factor | decimal | Price scaling factor |
| net | Money | Total additional item cost |
| udi | Reference(Device) | Unique Device Identifier |
| subDetail | BackboneElement | Additional items |
| sequence | positiveInt | Service instance |
| revenue | CodeableConcept | Revenue or cost center code |
| category | CodeableConcept | Type of service or product |
| service | CodeableConcept | Billing Code |
| modifier | CodeableConcept | Service/Product billing modifiers |
| programCode | CodeableConcept | Program specific reason for item inclusion |
| quantity | SimpleQuantity | Count of Products or Services |
| unitPrice | Money | Fee, charge or cost per point |
| factor | decimal | Price scaling factor |
| net | Money | Net additional item cost |
| udi | Reference(Device) | Unique Device Identifier |
| total | Money | Total claim cost |
EXF-FHIR Claim resource enables the user to retrieve the claim details based on the search parameters like identifier, insurer, organization, etc.
HTTP Method
:
GET
Request URL
:
STU3/Claim
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| Name | Type | Expression |
| care-team | reference | Claim.careTeam.provider |
| created | date | Claim.created |
| encounter | reference | Claim.item.encounter |
| enterer | reference | Claim.enterer |
| facility | reference | Claim.facility |
| identifier | token | Claim.identifier |
| insurer | reference | Claim.insurer |
| organization | reference | Claim.organization |
| patient | reference | Claim.patient |
| payee | reference | Claim.payee.party |
| priority | token | Claim.priority |
| provider | reference | Claim.provider |
| use | token | Claim.use |
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | Claim number |
| Status | Code | active | cancelled | draft | entered-in-error |
| Type | CodeableConcept | Type or discipline |
| Subtype | CodeableConcept | Finer grained claim type information |
| Use | Code | complete | proposed | exploratory | other |
| Patient | Reference(Patient) | The subject of the Products and Services |
| BillablePeriod | Period | Period for charge submission |
| Created | dateTime | Creation date |
| Enterer | Reference(Practitioner) | Author |
| Insurer | Reference(Organization) | Target |
| Provider | Reference(Practitioner) | Responsible provider |
| Organization | Reference(Organization) | Responsible organization |
| Priority | CodeableConcept | Specimens this report is based on |
| Funds Reserve | CodeableConcept | Funds requested to be reserved |
| Related | BackboneElement | Related Claims which may be relevant to processing this claim |
| Claim | Reference(Claim) | Reference to the related claim |
| Relationship | CodeableConcept | How the reference claim is related |
| Reference | Identifier | Related file or case reference |
| prescription | Reference(MedicationRequest | VisionPrescription) | Prescription authorizing services or products |
| originalPrescription | Reference(MedicationRequest) | Original prescription if superceded by fulfiller |
| payee | BackboneElement | Party to be paid any benefits payable |
| type | CodeableConcept | Type of party: Subscriber, Provider, other |
| resourceType | Coding | organization | patient | practitioner | relatedperson |
| party | Reference(Practitioner | Organization | Patient | RelatedPerson) | Party to receive the payable |
| referral | Reference(ReferralRequest) | Treatment Referral |
| facility | Reference(Location) | Servicing Facility |
| careTeam | BackboneElement | Members of the care team |
| sequence | positiveInt | Number to covey order of careTeam |
| provider | Reference(Practitioner | Organization) | Provider individual or organization |
| responsible | boolean | Billing provider |
| role | CodeableConcept | Role on the team |
| qualification | CodeableConcept | Type, classification or Specialization |
| information | BackboneElement | Exceptions, special considerations, the condition, situation, prior or concurrent issues |
| sequence | positiveInt | Information instance identifier |
| category | CodeableConcept | General class of information |
| code | CodeableConcept | Type of information |
| timingDate | date | When it occurred |
| timingPeriod | Period | When it occurred |
| valueString | string | Additional Data or supporting information |
| valueQuantity | Quantity | Additional Data or supporting information |
| valueAttachment | Attachment | Additional Data or supporting information |
| valueReference | Reference(Any) | Additional Data or supporting information |
| reason | CodeableConcept | Reason associated with the information |
| diagnosis | BackboneElement | List of Diagnosis |
| sequence | positiveInt | Number to covey order of diagnosis |
| diagnosisCodeableConcept | CodeableConcept | Patient's diagnosis |
| diagnosisReference | Reference(Condition) | Patient's diagnosis |
| type | CodeableConcept | Timing or nature of the diagnosis |
| packageCode | CodeableConcept | Package billing code |
| procedure | BackboneElement | Procedures performed |
| sequence | positiveInt | Procedure sequence for reference |
| date | dateTime | When the procedure was performed |
| procedureCodeableConcept | CodeableConcept | Patient's list of procedures performed |
| procedureReference | Reference(Procedure) | Patient's list of procedures performed |
| insurance | BackboneElement | Insurance or medical plan |
| sequence | positiveInt | Service instance identifier |
| focal | boolean | Is the focal Coverage |
| coverage | Reference(Coverage) | Insurance information |
| businessArrangement | string | Business agreement |
| preAuthRef | string | Pre-Authorization/Determination Reference |
| claimResponse | Reference(ClaimResponse) | Adjudication results |
| accident | BackboneElement | Details about an accident |
| date | date | When the accident occurred see information codes see information codes |
| type | CodeableConcept | The nature of the accident |
| locationAddress | Address | Accident Place |
| locationReference | Reference(Location) | Accident Place |
| employmentImpacted | Period | Period unable to work |
| hospitalization | Period | Period in hospital |
| item | BackboneElement | Goods and Services |
| sequence | positiveInt | Service instance |
| careTeamLinkId | positiveInt | Applicable careTeam members |
| diagnosisLinkId | positiveInt | Applicable diagnoses |
| procedureLinkId | positiveInt | Applicable procedures |
| informationLinkId | positiveInt | Applicable exception and supporting information |
| revenue | CodeableConcept | Revenue or cost center code |
| category | CodeableConcept | Type of service or product |
| service | CodeableConcept | Billing Code |
| modifier | CodeableConcept | Service/Product billing modifiers |
| programCode | CodeableConcept | Program specific reason for item inclusion |
| servicedDate | date | Date or dates of Service |
| servicedPeriod | Period | Date or dates of Service |
| locationCodeableConcept | CodeableConcept | Place of service |
| locationAddress | Address | Place of service |
| locationReference | Reference(Location) | Place of service |
| quantity | SimpleQuantity | Count of Products or Services |
| unitPrice | Money | Fee, charge or cost per point |
| factor | decimal | Price scaling factor |
| net | Money | Total item cost |
| udi | Reference(Device) | Unique Device Identifier |
| bodySite | CodeableConcept | Service Location |
| subSite | CodeableConcept | Service Sub-location |
| encounter | Reference(Encounter) | Encounters related to this billed item |
| detail | BackboneElement | Additional items |
| sequence | positiveInt | Service instance |
| revenue | CodeableConcept | Revenue or cost center code |
| category | CodeableConcept | Type of service or product |
| service | CodeableConcept | Billing Code |
| modifier | CodeableConcept | Service/Product billing modifiers |
| programCode | CodeableConcept | Program specific reason for item inclusion |
| quantity | SimpleQuantity | Count of Products or Services |
| unitPrice | Money | Fee, charge or cost per point |
| factor | decimal | Price scaling factor |
| net | Money | Total additional item cost |
| udi | Reference(Device) | Unique Device Identifier |
| subDetail | BackboneElement | Additional items |
| sequence | positiveInt | Service instance |
| revenue | CodeableConcept | Revenue or cost center code |
| category | CodeableConcept | Type of service or product |
| service | CodeableConcept | Billing Code |
| modifier | CodeableConcept | Service/Product billing modifiers |
| programCode | CodeableConcept | Program specific reason for item inclusion |
| quantity | SimpleQuantity | Count of Products or Services |
| unitPrice | Money | Fee, charge or cost per point |
| factor | decimal | Price scaling factor |
| net | Money | Net additional item cost |
| udi | Reference(Device) | Unique Device Identifier |
| total | Money | Total claim cost |
EXF-FHIR Goal resource enables the user to create the details of intended objective(s) for a patient, group or organization care.
HTTP Method
:
POST
Request URL
:
STU3/Goal
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | External Ids for this goal |
| status | code | propose | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | enter-in-error | rejected |
| category | CodeableConcept | E.g. Treatment, dietary,behavioral, etc. |
| priority | CodeableConcept | high-priority | medium-priority | low-priority |
| description | CodeableConcept | Code or text describing goal |
| subject | Reference(Patient | Group | Organization) | Who this goal is intended for |
| startDate | date | When goal pursuit begins |
| startCodeableConcept | CodeableConcept | When goal pursuit begins |
| target | BackboneElement | Target outcome for the goal |
| measure | CodeableConcept | The parameter whose value is being tracked |
| detailQuantity | Quantity | The type of contact |
| detailRange | Range | The target value to be achieved |
| detailCodeableConcept | CodeableConcept | The target value to be achieved |
| dueDate | date | Reach goal on or before |
| dueDuration | Duration | Reach goal on or before |
| statusDate | date | When goal status took effect |
| statusReason | string | Reason for current status |
| expressedBy | Reference(Patient | Practitioner | RelatedPerson) | Who's responsible for creating Goal? |
| addresses | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ProcedureRequest | RiskAssessment) | Issues addressed by this goal |
| note | Annotation | Comments about the goal |
| outcomeCode | CodeableConcept | What result was achieved regarding the goal? |
| outcomeReference | Reference(Observation) | Observation that resulted from goal |
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
EXF-FHIR Goal resource enables the user to retrieve the details of intended objective(s) for a patient, group or organization care.
HTTP Method
:
GET
Request URL
:
STU3/Goal
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | External Ids for this goal |
| status | code | propose | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | enter-in-error | rejected |
| category | CodeableConcept | E.g. Treatment, dietary,behavioral, etc. |
| priority | CodeableConcept | high-priority | medium-priority | low-priority |
| description | CodeableConcept | Code or text describing goal |
| subject | Reference(Patient | Group | Organization) | Who this goal is intended for |
| startDate | date | When goal pursuit begins |
| startCodeableConcept | CodeableConcept | When goal pursuit begins |
| target | BackboneElement | Target outcome for the goal |
| measure | CodeableConcept | The parameter whose value is being tracked |
| detailQuantity | Quantity | The type of contact |
| detailRange | Range | The target value to be achieved |
| detailCodeableConcept | CodeableConcept | The target value to be achieved |
| dueDate | date | Reach goal on or before |
| dueDuration | Duration | Reach goal on or before |
| statusDate | date | When goal status took effect |
| statusReason | string | Reason for current status |
| expressedBy | Reference(Patient | Practitioner | RelatedPerson) | Who's responsible for creating Goal? |
| addresses | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ProcedureRequest | RiskAssessment) | Issues addressed by this goal |
| note | Annotation | Comments about the goal |
| outcomeCode | CodeableConcept | What result was achieved regarding the goal? |
| outcomeReference | Reference(Observation) | Observation that resulted from goal |
EXF-FHIR Goal resource enables the user to retrieve the details of intended objective(s) for a patient, group or organization care based on the search parameters like identifier, category, subject, etc.
HTTP Method
:
GET
Request URL
:
STU3/Goal
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| category | token | Goal.category |
| identifier | token | Goal.identifier |
| patient | reference | Goal.subject |
| start-date | date | Goal.start.as(Date) |
| status | token | Goal.status |
| subject | reference | Goal.subject |
| target-date | date | Goal.target.due.as(Date) |
| Name | Type | Description |
|---|---|---|
| identifier | Identifier | External Ids for this goal |
| status | code | propose | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | enter-in-error | rejected |
| category | CodeableConcept | E.g. Treatment, dietary,behavioral, etc. |
| priority | CodeableConcept | high-priority | medium-priority | low-priority |
| description | CodeableConcept | Code or text describing goal |
| subject | Reference(Patient | Group | Organization) | Who this goal is intended for |
| startDate | date | When goal pursuit begins |
| startCodeableConcept | CodeableConcept | When goal pursuit begins |
| target | BackboneElement | Target outcome for the goal |
| measure | CodeableConcept | The parameter whose value is being tracked |
| detailQuantity | Quantity | The type of contact |
| detailRange | Range | The target value to be achieved |
| detailCodeableConcept | CodeableConcept | The target value to be achieved |
| dueDate | date | Reach goal on or before |
| dueDuration | Duration | Reach goal on or before |
| statusDate | date | When goal status took effect |
| statusReason | string | Reason for current status |
| expressedBy | Reference(Patient | Practitioner | RelatedPerson) | Who's responsible for creating Goal? |
| addresses | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ProcedureRequest | RiskAssessment) | Issues addressed by this goal |
| note | Annotation | Comments about the goal |
| outcomeCode | CodeableConcept | What result was achieved regarding the goal? |
| outcomeReference | Reference(Observation) | Observation that resulted from goal |
HTTP Method
:
POST
Request URL
:
STU3/Patient
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | An identifier for this patient |
| Active | boolean | Whether this patient's record is in active use |
| Name | HumanName | The patient's name |
| Telecom | ContactPoint | Patient Contact Details |
| Gender | Code | Male|Female|Other|Unknown |
| Birth Date | Date | Patient’s Date of Birth |
| deceasedBoolean | Boolean | True or False |
| deceasedDatetime | DateTime | The Date and time of the Patient if deceased. |
| Addressed | Address | Patient Permanent address |
| Marital Status | CodeableConcept | Marital (civil) status of a patient |
| Contact | ContactPoint | Gaurdian or Parent details of the patient |
| Communication | BackboneElement | A list of languages which may be used to communicate with the patient |
| Language | Codeableconcept | The language which can be used to communicate with the patient about his or her health |
| Preferred | Boolean | Language preference indicator |
| generalPractioner | Reference(Organization|Practioner) | Patient's nominated primary care provider |
| ManagingOrganization | Reference(Organization) | ble> |
|
Organization that is the custodian of the patient record |
||
HTTP/1.1 201 Created
Cache-Control
:
no-cache
Pragma
:
no-cache
Content-Type
:
application/json; charset=utf-8
This Resource covers data about patients involved in a wide range of health-related activities, including:
HTTP Method
:
GET
Request URL
:
STU3/Patient
Content Type
:
application/json
Example
:-
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | An identifier for this patient |
| Active | boolean | Whether this patient's record is in active use |
| Name | HumanName | The patient's name |
| Telecom | ContactPoint | Patient Contact Details |
| Gender | Code | Male|Female|Other|Unknown |
| Birth Date | Date | Patient’s Date of Birth |
| deceasedBoolean | Boolean | True or False |
| deceasedDatetime | DateTime | The Date and time of the Patient if deceased. |
| Addressed | Address | Patient Permanent address |
| Marital Status | CodeableConcept | Marital (civil) status of a patient |
| Contact | ContactPoint | Gaurdian or Parent details of the patient |
| Communication | BackboneElement | A list of languages which may be used to communicate with the patient |
| Language | Codeableconcept | The language which can be used to communicate with the patient about his or her health |
| Preferred | Boolean | Language preference indicator |
| generalPractioner | Reference(Organization|Practioner) | Patient's nominated primary care provider |
| ManagingOrganization | Reference(Organization) | ble> |
|
Organization that is the custodian of the patient record |
||
This Resource covers data about patients involved in a wide range of health-related activities, including:
HTTP Method
:
GET
Request URL
:
STU3/Patient
Content Type
:
application/json
Example
:-
| Name | Type | Expression |
|---|---|---|
| active | token | Patient.active |
| address | String | Patient.address |
| Address-city | String | Patient.address.city |
| address-country | String | Patient.address.country |
| gender | token | Patient.gender |
| Name | Type | Description |
|---|---|---|
| Identifier | Identifier | An identifier for this patient |
| Active | boolean | Whether this patient's record is in active use |
| Name | HumanName | The patient's name |
| Telecom | ContactPoint | Patient Contact Details |
| Gender | Code | Male|Female|Other|Unknown |
| Birth Date | Date | Patient’s Date of Birth |
| deceasedBoolean | Boolean | True or False |
| deceasedDatetime | DateTime | The Date and time of the Patient if deceased. |
| Addressed | Address | Patient Permanent address |
| Marital Status | CodeableConcept | Marital (civil) status of a patient |
| Contact | ContactPoint | Gaurdian or Parent details of the patient |
| Communication | BackboneElement | A list of languages which may be used to communicate with the patient |
| Language | Codeableconcept | The language which can be used to communicate with the patient about his or her health |
| Preferred | Boolean | Language preference indicator |
| generalPractioner | Reference(Organization|Practioner) | Patient's nominated primary care provider |
| ManagingOrganization | Reference(Organization) | ble> |
|
Organization that is the custodian of the patient record |
||