Sign Up form



CarePlan. Create (STU 3)

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).

General Information

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

Request
http://127.0.0.1:8183/STU3/Careplan

Content Type

:

application/json

Example

:-

{ "_id" : "b3b82491-ed59-432e-bbf0-bc28c845b318", "resourceType" : "CarePlan", "identifier" : [], "definition" : [], "basedOn" : [], "replaces" : [], "partOf" : [], "status" : "active", "intent" : "order", "category" : [ { "coding" : [ { "system" : "http://snomed.info/sct", "code" : "698360004", "display" : "Diabetes self management plan", "userSelected" : false } ], "text" : "Diabetes self management plan" } ], "subject" : { "reference" : "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context" : { "reference" : "urn:uuid:ad8a0338-8a11-4ee3-b49e-382701c8a3a9" }, "period" : { "start" : "1987-12-21T11:22:41.000Z" }, "author" : [], "careTeam" : [], "addresses" : [ { "reference" : "urn:uuid:b4224db5-62bc-4c2a-a6f1-cb276607f8bc" } ], "supportingInfo" : [], "goal" : [ { "reference" : "urn:uuid:1259c7bc-6a5f-41ee-84b0-f3b8c1dd69e2" }, { "reference" : "urn:uuid:f527f394-89ba-4125-aec5-f217a38e9716" }, { "reference" : "urn:uuid:e579432b-9f72-4fc7-a472-3c2ef3e60ad3" }, { "reference" : "urn:uuid:29a71cff-9b9b-44f0-8f52-910ba951bd63" }, { "reference" : "urn:uuid:2f33a99e-32fd-4bc5-ba9f-53f4ee664a8c" } ], "activity" : [ { "outcomeCodeableConcept" : [], "outcomeReference" : [], "progress" : [], "detail" : { "code" : { "coding" : [ { "system" : "http://snomed.info/sct", "code" : "160670007", "display" : "Diabetic diet", "userSelected" : false } ], "text" : "Diabetic diet" }, "reasonCode" : [], "reasonReference" : [], "goal" : [], "status" : "", "prohibited" : false, "performer" : [] } }, { "outcomeCodeableConcept" : [], "outcomeReference" : [], "progress" : [], "detail" : { "code" : { "coding" : [ { "system" : "http://snomed.info/sct", "code" : "229065009", "display" : "Exercise therapy", "userSelected" : false } ], "text" : "Exercise therapy" }, "reasonCode" : [], "reasonReference" : [], "goal" : [], "status" : "", "prohibited" : false, "performer" : [] } } ], "note" : [] }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

CarePlan.Read (STU 3)

Description:

EXF-FHIR CarePlan resource enables the user to retrieve the Practitioner’s plan of treatment, patient conditions and patient goals with their references.

General Information

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

Request
http://localhost:8183/STU3/CarePlan/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/CarePlan/b3b82491-ed59-432e-bbf0-bc28c845b318

Structure

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

Response

{ "resourceType": "CarePlan", "id": "b3b82491-ed59-432e-bbf0-bc28c845b318", "meta": { "versionId": "1", "lastUpdated": "2021-01-28T14:24:55.606+00:00", "profile": [ "https://www.hl7.org/fhir/carePlan.html" ] }, "intent": "order", "category": [{ "coding": [{ "system": "http://snomed.info/sct", "code": "698360004", "display": "Diabetes self management plan" }], "text": "Diabetes self management plan" }], "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:ad8a0338-8a11-4ee3-b49e-382701c8a3a9" }, "period": { "start": "1987-12-21T11:22:41+00:00" }, "addresses": [{ "reference": "urn:uuid:b4224db5-62bc-4c2a-a6f1-cb276607f8bc" }], "goal": [{ "reference": "urn:uuid:1259c7bc-6a5f-41ee-84b0-f3b8c1dd69e2" }, { "reference": "urn:uuid:f527f394-89ba-4125-aec5-f217a38e9716" }, { "reference": "urn:uuid:e579432b-9f72-4fc7-a472-3c2ef3e60ad3" }, { "reference": "urn:uuid:29a71cff-9b9b-44f0-8f52-910ba951bd63" }, { "reference": "urn:uuid:2f33a99e-32fd-4bc5-ba9f-53f4ee664a8c" } ], "activity": [{ "detail": { "code": { "coding": [{ "system": "http://snomed.info/sct", "code": "160670007", "display": "Diabetic diet" }], "text": "Diabetic diet" } } }, { "detail": { "code": { "coding": [{ "system": "http://snomed.info/sct", "code": "229065009", "display": "Exercise therapy" }], "text": "Exercise therapy" } } } ] }

CarePlan.Search (STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Careplan

Request
http://localhost:8183/STU3/CarePlan?patient=?

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/CarePlan?patient=urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992

Search Parameters

Name Type Expression
identifier Token CarePlan.identifier
Goal Reference CarePlan.goal
Patient Reference CarePlan.subject
status Token CarePlan.status

Structure

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

Response

{ "resourceType": "CarePlan", "id": "b3b82491-ed59-432e-bbf0-bc28c845b318", "meta": { "versionId": "1", "lastUpdated": "2021-01-28T14:24:55.606+00:00", "profile": [ "https://www.hl7.org/fhir/carePlan.html" ] }, "intent": "order", "category": [{ "coding": [{ "system": "http://snomed.info/sct", "code": "698360004", "display": "Diabetes self management plan" }], "text": "Diabetes self management plan" }], "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:ad8a0338-8a11-4ee3-b49e-382701c8a3a9" }, "period": { "start": "1987-12-21T11:22:41+00:00" }, "addresses": [{ "reference": "urn:uuid:b4224db5-62bc-4c2a-a6f1-cb276607f8bc" }], "goal": [{ "reference": "urn:uuid:1259c7bc-6a5f-41ee-84b0-f3b8c1dd69e2" }, { "reference": "urn:uuid:f527f394-89ba-4125-aec5-f217a38e9716" }, { "reference": "urn:uuid:e579432b-9f72-4fc7-a472-3c2ef3e60ad3" }, { "reference": "urn:uuid:29a71cff-9b9b-44f0-8f52-910ba951bd63" }, { "reference": "urn:uuid:2f33a99e-32fd-4bc5-ba9f-53f4ee664a8c" } ], "activity": [{ "detail": { "code": { "coding": [{ "system": "http://snomed.info/sct", "code": "160670007", "display": "Diabetic diet" }], "text": "Diabetic diet" } } }, { "detail": { "code": { "coding": [{ "system": "http://snomed.info/sct", "code": "229065009", "display": "Exercise therapy" }], "text": "Exercise therapy" } } } ] }

Organization.Create(STU 3)

Description

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.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Organisation

Request
http://127.0.0.1:8183/STU3/Organization

Content Type

:

application/json

Example

:-

{ "resourceType": "Organization", "id": "hl7", "identifier": [{ "system": "https://github.com/synthetichealth/synthea", "value": "8ad64ecf-c817-3753-bee7-006a8e662e06" }], "type": [{ "coding": [{ "system": "http://hl7.org/fhir/organization-type", "code": "prov", "display": "Healthcare Provider" }], "text": "Healthcare Provider" }], "extension": [{ "url": "http://hl7.org/fhir/StructureDefinition/organization-alias", "valueString": "HL7 International" }], "name": "Health Level Seven International", "telecom": [{ "system": "phone", "value": "(+1) 734-677-7777" }, { "system": "fax", "value": "(+1) 734-677-6622" }, { "system": "email", "value": "hq@HL7.org" } ], "address": [{ "line": [ "3300 Washtenaw Avenue, Suite 227" ], "city": "Ann Arbor", "state": "MI", "postalCode": "48104", "country": "USA" }], "endpoint": [{ "reference": "Endpoint/example" }] }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Organization.Read(STU 3)

Description

EXF-FHIR Organization resource enables the user to retrieve the details of an organization.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Organization

Request
http://localhost:8183/STU3/Organization/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Organization/8ad64ecf-c817-3753-bee7-006a8e662e06

Structure

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

Response

{ "resourceType": "Organization", "id": "8ad64ecf-c817-3753-bee7-006a8e662e06", "meta": { "versionId": "1", "lastUpdated": "2021-01-28T08:50:05.871+00:00", "profile": [ "https://www.hl7.org/fhir/organization.html" ] }, "identifier": [{ "system": "https://github.com/synthetichealth/synthea", "value": "8ad64ecf-c817-3753-bee7-006a8e662e06" }], "type": [{ "coding": [{ "system": "http://hl7.org/fhir/organization-type", "code": "prov", "display": "Healthcare Provider" }], "text": "Healthcare Provider" }], "name": "MORTON HOSPITAL", "telecom": [{ "system": "phone", "value": "5088287000", "rank": 0 }], "address": [{ "city": "TAUNTON", "state": "MA", "postalCode": "02780", "country": "US" }] }

Organization.Search(STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Organization

Request
http://localhost:8183/STU3/Organization?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Organization?name=MORTON HOSPITAL

Search Parameters

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

Structure

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

Response

{ "resourceType": "Organization", "id": "8ad64ecf-c817-3753-bee7-006a8e662e06", "meta": { "versionId": "1", "lastUpdated": "2021-01-28T08:50:05.871+00:00", "profile": [ "https://www.hl7.org/fhir/organization.html" ] }, "identifier": [ { "system": "https://github.com/synthetichealth/synthea", "value": "8ad64ecf-c817-3753-bee7-006a8e662e06" } ], "type": [ { "coding": [ { "system": "http://hl7.org/fhir/organization-type", "code": "prov", "display": "Healthcare Provider" } ], "text": "Healthcare Provider" } ], "name": "MORTON HOSPITAL", "telecom": [ { "system": "phone", "value": "5088287000", "rank": 0 } ], "address": [ { "city": "TAUNTON", "state": "MA", "postalCode": "02780", "country": "US" } ] }

Encounter.Create(STU 3)

Description

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.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Encounter

Request
http://localhost:8183/STU3/Encounter

Content Type

:

application/json

Example

:-

{ "_id" : "74816842-a979-45a3-b153-d145e253fe4f", "resourceType": "Encounter", "identifier" : [], "status" : "finished", "statusHistory" : [], "class_" : { "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "EMER", "userSelected" : false }, "classHistory" : [], "type" : [ { "coding" : [ { "system" : "http://snomed.info/sct", "code" : "410429000", "display" : "Cardiac Arrest", "userSelected" : false } ], "text" : "Cardiac Arrest" } ], "subject" : { "reference" : "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "episodeOfcare" : [], "incomingRefferal" : [], "participant" : [ { "type" : [], "individual" : { "reference" : "urn:uuid:0000016d-3a85-4cca-0000-000000000122" } } ], "period" : { "start" : "1965-11-15T11:22:41.000Z", "end" : "1965-11-15T13:07:41.000Z" }, "reason" : [], "diagnosis" : [], "account" : [], "location" : [], "serviceProvider" : { "reference" : "urn:uuid:8ad64ecf-c817-3753-bee7-006a8e662e06" } }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Encounter.Read(STU 3)

Description

EXF-FHIR Encounter resource enables the user to retrieve the patient healthcare details by using the unique identifier only.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Encounter

Request
http://localhost:8183/STU3/Encounter/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Encounter/74816842-a979-45a3-b153-d145e253fe4f

Structure

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

Response

{ "resourceType": "Encounter", "id": "74816842-a979-45a3-b153-d145e253fe4f", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T14:39:21.226+00:00", "profile": [ "https://www.hl7.org/fhir/encounter.html" ] }, "status": "finished", "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "410429000", "display": "Cardiac Arrest" } ], "text": "Cardiac Arrest" } ], "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "participant": [ { "individual": { "reference": "urn:uuid:0000016d-3a85-4cca-0000-000000000122" } } ], "period": { "start": "1965-11-15T11:22:41+00:00", "end": "1965-11-15T13:07:41+00:00" }, "serviceProvider": { "reference": "urn:uuid:8ad64ecf-c817-3753-bee7-006a8e662e06" } }

Encounter.Search(STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Encounter

Request
http://localhost:8183/STU3/Encounter?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Encounter?patient=urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992

Search Parameters

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

Structure

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

Response

{ "resourceType": "Bundle", "id": "df0372f7-0fb0-4beb-b4f0-9220a83a574e", "meta": { "lastUpdated": "2021-01-29T14:41:42.997+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/Encounter?patient=urn%3Auuid%3Aac3de6f1-e236-4200-b9da-f1b7758de992" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/Encounter/74816842-a979-45a3-b153-d145e253fe4f", "resource": { "resourceType": "Encounter", "id": "74816842-a979-45a3-b153-d145e253fe4f", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T14:39:21.226+00:00", "profile": [ "https://www.hl7.org/fhir/encounter.html" ] }, "status": "finished", "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "410429000", "display": "Cardiac Arrest" } ], "text": "Cardiac Arrest" } ], "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "participant": [ { "individual": { "reference": "urn:uuid:0000016d-3a85-4cca-0000-000000000122" } } ], "period": { "start": "1965-11-15T11:22:41+00:00", "end": "1965-11-15T13:07:41+00:00" }, "serviceProvider": { "reference": "urn:uuid:8ad64ecf-c817-3753-bee7-006a8e662e06" } } } ] }

Practitioner.Create (STU 3)

Description

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.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Practitioner

Request
http://127.0.0.1:8183/STU3/Practitioner

Content Type

:

application/json

Example

:-

{ "resourceType": "Practitioner", "id": "0000016d-3a85-4cca-0000-00000000b4d2", "identifier": [ { "system": "http://hl7.org/fhir/sid/us-npi", "value": "290" } ], "active": true, "name": [ { "family": "Breitenberg7" } ], "address": [ { "city": "TAUNTON", "state": "MA", "postalCode": "02780", "country": "US" } ], "gender": "male" }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Practitioner.Read(STU 3)

Description

EXF-FHIR Practitioner resource enables the user to retrieve the Practitioner details of a healthcare organization with the help of a unique identifier.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Practitioner

Request
http://localhost:8183/STU3/Practitioner/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Practitioner/0000016d-3a85-4cca-0000-00000000b4d2

Structure

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

Response

{ "resourceType": "Practitioner", "id": "0000016d-3a85-4cca-0000-00000000b4d2", "identifier": [ { "system": "http://hl7.org/fhir/sid/us-npi", "value": "290" } ], "active": true, "name": [ { "family": "Breitenberg7" } ], "address": [ { "city": "TAUNTON", "state": "MA", "postalCode": "02780", "country": "US" } ], "gender": "male" }

Practitioner.Search(STU 3)

Description

EXF-FHIR Practitioner resource enables the user to retrieve the required details of Practitioners based on the search parameters like address, family, gender, etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Practitioner

Request
http://localhost:8183/STU3/Practitioner?address=TAUNTON

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Practitioner?address=TAUNTON

Search Parameters

Name Type Expression
active Token Practitioner.active
address String Practitioner.address
family String Practitioner.name.family
gender Token Practitioner.gender

Structure

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

Response

{ "resourceType": "Bundle", "id": "9ce63f2e-6ee4-444b-8571-a4bf0ab80b63", "meta": { "lastUpdated": "2021-01-28T08:43:15.115+00:00" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/Practitioner?address=TAUNTON" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/Practitioner/0000016d-3a85-4cca-0000-00000000b4d2", "resource": { "resourceType": "Practitioner", "id": "0000016d-3a85-4cca-0000-00000000b4d2", "meta": { "versionId": "1", "lastUpdated": "2021-01-28T08:39:17.410+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Practitioner" ] }, "identifier": [ { "system": "http://hl7.org/fhir/sid/us-npi", "value": "290" } ], "active": true, "name": [ { "family": "Breitenberg7" } ], "address": [ { "city": "TAUNTON", "state": "MA", "postalCode": "02780", "country": "US" } ], "gender": "male" } }, { "fullUrl": "http://localhost:8183/STU3/Practitioner/0000016d-3a85-4cca-0000-00000000b4d2", "resource": { "resourceType": "Practitioner", "id": "0000016d-3a85-4cca-0000-00000000b4d2", "meta": { "versionId": "4", "lastUpdated": "2021-01-28T08:41:49.117+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Practitioner" ] }, "identifier": [ { "system": "http://hl7.org/fhir/sid/us-npi", "value": "290" } ], "active": true, "name": [ { "family": "Breitenberg7" } ], "address": [ { "city": "TAUNTON", "state": "MA", "postalCode": "02780", "country": "US" } ], "gender": "male" } } ] }

Condition.Create (STU 3)

Description

EXF-FHIR Condition resource enables the user to create Condition details of the patient like Clinical status, Verification status, Category, Severity, etc.>/p>

General Information

HTTP Method

:

POST

Request URL

:

STU3/Condition

Request
http://127.0.0.1:8183/STU3/Condition

Content Type

:

application/json

Example

:-

{ "_id" : "566d4250-83ff-44fd-81e9-8ed99085f046", "resourceType" : "Condition", "identifier" : [], "clinicalStatus" : "active", "verificationStatus" : "confirmed", "category" : [], "code" : { "coding" : [ { "system" : "http://snomed.info/sct", "code" : "410429000", "display" : "Cardiac Arrest", "userSelected" : false } ], "text" : "Cardiac Arrest" }, "bodySite" : [], "subject" : { "reference" : "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context" : { "reference" : "urn:uuid:74816842-a979-45a3-b153-d145e253fe4f" }, "onsetDateTime" : { "_id" : null, "myFractionalSeconds" : "", "myPrecision" : "SECOND", "myTimeZone" : { "_class" : "sun.util.calendar.ZoneInfo", "rawOffset" : -18000000, "rawOffsetDiff" : 0, "checksum" : 0, "dstSavings" : 0, "willGMTOffsetChange" : false, "dirty" : false, "ID" : "GMT-05:00" }, "myTimeZoneZulu" : false, "myCoercedValue" : "1965-11-15T11:22:41.000Z", "myStringValue" : "1965-11-15T06:22:41-05:00" }, "evidence" : [], "note" : [] }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Condition.Read(STU 3)

Description

EXF-FHIR Condition resource enables the user to retrieve the Condition details of the patient like Clinical status, Verification status, Category, Severity, etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Condition

Request
http://localhost:8183/STU3/Condition/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Condition/566d4250-83ff-44fd-81e9-8ed99085f046

Structure

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

Response

{ "resourceType": "Condition", "id": "566d4250-83ff-44fd-81e9-8ed99085f046", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T07:20:45.803+00:00", "profile": [ "https://www.hl7.org/fhir/condition.html" ] }, "clinicalStatus": "active", "verificationStatus": "confirmed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "410429000", "display": "Cardiac Arrest" } ], "text": "Cardiac Arrest" }, "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:74816842-a979-45a3-b153-d145e253fe4f" } }

Condition.Search(STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Condition

Request
http://localhost:8183/STU3/Condition?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Condition?patient=urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992

Search Parameters

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)

Structure

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

Response

{ "resourceType": "Bundle", "id": "d4c9289c-6c5a-4a9f-abf0-2ca5d78b4a21", "meta": { "lastUpdated": "2021-01-29T07:24:12.401+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/Condition?patient=urn%3Auuid%3Aac3de6f1-e236-4200-b9da-f1b7758de992" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/Condition/566d4250-83ff-44fd-81e9-8ed99085f046", "resource": { "resourceType": "Condition", "id": "566d4250-83ff-44fd-81e9-8ed99085f046", "meta": { "versionId": "2", "lastUpdated": "2021-01-29T07:22:49.516+00:00", "profile": [ "https://www.hl7.org/fhir/condition.html" ] }, "clinicalStatus": "active", "verificationStatus": "confirmed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "410429000", "display": "Cardiac Arrest" } ], "text": "Cardiac Arrest" }, "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:74816842-a979-45a3-b153-d145e253fe4f" } } } ] }

DiagnosticReport.Create (STU 3)

Description

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.

General Information

HTTP Method

:

POST

Request URL

:

STU3/DiagnosticReport

Request
http://localhost:8183/STU3/DiagnosticReport

Content Type

:

application/json

Example

:-

{ "_id" : "bb35d9bd-e994-4bce-824c-bb78372ac9f5", "resourceType" : "DiagnosticReport", "identifier" : [], "basedOn" : [], "status" : "final", "code" : { "coding" : [ { "system" : "http://loinc.org", "code" : "51990-0", "display" : "Basic Metabolic Panel", "userSelected" : false } ], "text" : "Basic Metabolic Panel" }, "subject" : { "reference" : "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context" : { "reference" : "urn:uuid:e0d01182-27a5-47c9-a4c5-81e5feb3b4cc" }, "effectiveDateTime" : { "_id" : null, "myFractionalSeconds" : "", "myPrecision" : "SECOND", "myTimeZone" : { "_class" : "sun.util.calendar.ZoneInfo", "rawOffset" : -18000000, "rawOffsetDiff" : 0, "checksum" : 0, "dstSavings" : 0, "willGMTOffsetChange" : false, "dirty" : false, "ID" : "GMT-05:00" }, "myTimeZoneZulu" : false, "myCoercedValue" : "2010-03-01T11:22:41.000Z", "myStringValue" : "2010-03-01T06:22:41-05:00" }, "issued" : "2010-03-01T11:22:41.399Z", "performer" : [], "specimen" : [], "result" : [ { "reference" : "urn:uuid:7ccb45f3-1eb5-42c6-9d9f-d6bc23d43386", "display" : "Glucose" }, { "reference" : "urn:uuid:e5462158-2d9e-440b-9fbe-97aa0522e2be", "display" : "Urea Nitrogen" }, { "reference" : "urn:uuid:1b29b856-1b6b-4be9-a832-3fc4a29dd25f", "display" : "Creatinine" }, { "reference" : "urn:uuid:cbcf0d2a-3c2e-4e7a-bcdd-196922d31096", "display" : "Calcium" }, { "reference" : "urn:uuid:ccd96061-4617-4e71-b2e3-e725c56391c2", "display" : "Sodium" }, { "reference" : "urn:uuid:eb6456d5-9e40-4a51-8c9c-08522b636f43", "display" : "Potassium" }, { "reference" : "urn:uuid:00617682-3025-4776-99a3-0e639eeb0423", "display" : "Chloride" }, { "reference" : "urn:uuid:3f4c5a19-8347-4100-b34f-378b5b3a422c", "display" : "Carbon Dioxide" } ], "imagingStudy" : [], "image" : [], "codedDiagnosis" : [], "presentedForm" : [] }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

DiagnosticReport.Read(STU 3)

Description

EXF-FHIR Diagnostic Report resource enables the user to retrieve the Diagnostic reports of a patient.

General Information

HTTP Method

:

GET

Request URL

:

STU3/DiagnosticReport

Request
http://localhost:8183/STU3/DiagnosticReport/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/DiagnosticReport/bb35d9bd-e994-4bce-824c-bb78372ac9f5

Structure

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

Response

{ "resourceType": "DiagnosticReport", "id": "bb35d9bd-e994-4bce-824c-bb78372ac9f5", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T15:16:55.166+00:00", "profile": [ "https://www.hl7.org/fhir/diagnosticReport.html" ] }, "status": "final", "code": { "coding": [ { "system": "http://loinc.org", "code": "51990-0", "display": "Basic Metabolic Panel" } ], "text": "Basic Metabolic Panel" }, "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:e0d01182-27a5-47c9-a4c5-81e5feb3b4cc" }, "issued": "2010-03-01T11:22:41.399+00:00", "result": [ { "reference": "urn:uuid:7ccb45f3-1eb5-42c6-9d9f-d6bc23d43386", "display": "Glucose" }, { "reference": "urn:uuid:e5462158-2d9e-440b-9fbe-97aa0522e2be", "display": "Urea Nitrogen" }, { "reference": "urn:uuid:1b29b856-1b6b-4be9-a832-3fc4a29dd25f", "display": "Creatinine" }, { "reference": "urn:uuid:cbcf0d2a-3c2e-4e7a-bcdd-196922d31096", "display": "Calcium" }, { "reference": "urn:uuid:ccd96061-4617-4e71-b2e3-e725c56391c2", "display": "Sodium" }, { "reference": "urn:uuid:eb6456d5-9e40-4a51-8c9c-08522b636f43", "display": "Potassium" }, { "reference": "urn:uuid:00617682-3025-4776-99a3-0e639eeb0423", "display": "Chloride" }, { "reference": "urn:uuid:3f4c5a19-8347-4100-b34f-378b5b3a422c", "display": "Carbon Dioxide" } ] }

DiagnosticReport.Search(STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/DiagnosticReport

Request
http://localhost:8183/STU3/DiagnosticReport?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/DiagnosticReport?patient=urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992

Search Parameters

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

Structure

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

Response

{ "resourceType": "Bundle", "id": "d107fd42-f4c1-4b70-9660-98526476c22e", "meta": { "lastUpdated": "2021-01-29T15:19:41.688+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/DiagnosticReport?patient=urn%3Auuid%3Aac3de6f1-e236-4200-b9da-f1b7758de992" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/DiagnosticReport/bb35d9bd-e994-4bce-824c-bb78372ac9f5", "resource": { "resourceType": "DiagnosticReport", "id": "bb35d9bd-e994-4bce-824c-bb78372ac9f5", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T15:16:55.166+00:00", "profile": [ "https://www.hl7.org/fhir/diagnosticReport.html" ] }, "status": "final", "code": { "coding": [ { "system": "http://loinc.org", "code": "51990-0", "display": "Basic Metabolic Panel" } ], "text": "Basic Metabolic Panel" }, "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:e0d01182-27a5-47c9-a4c5-81e5feb3b4cc" }, "issued": "2010-03-01T11:22:41.399+00:00", "result": [ { "reference": "urn:uuid:7ccb45f3-1eb5-42c6-9d9f-d6bc23d43386", "display": "Glucose" }, { "reference": "urn:uuid:e5462158-2d9e-440b-9fbe-97aa0522e2be", "display": "Urea Nitrogen" }, { "reference": "urn:uuid:1b29b856-1b6b-4be9-a832-3fc4a29dd25f", "display": "Creatinine" }, { "reference": "urn:uuid:cbcf0d2a-3c2e-4e7a-bcdd-196922d31096", "display": "Calcium" }, { "reference": "urn:uuid:ccd96061-4617-4e71-b2e3-e725c56391c2", "display": "Sodium" }, { "reference": "urn:uuid:eb6456d5-9e40-4a51-8c9c-08522b636f43", "display": "Potassium" }, { "reference": "urn:uuid:00617682-3025-4776-99a3-0e639eeb0423", "display": "Chloride" }, { "reference": "urn:uuid:3f4c5a19-8347-4100-b34f-378b5b3a422c", "display": "Carbon Dioxide" } ] } } ] }

Immunization.Create (STU 3)

Description

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.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Immunization

Request
http://localhost:8183/STU3/Immunization

Content Type

:

application/json

Example

:-

{ "_id" : "43dc845b-76d9-4d23-bab2-904aa85c3162", "resourceType" : "Immunization", "identifier" : [], "status" : "completed", "notGiven" : false, "vaccineCode" : { "coding" : [ { "system" : "http://hl7.org/fhir/sid/cvx", "code" : "140", "display" : "Influenza, seasonal, injectable, preservative free", "userSelected" : false } ], "text" : "Influenza, seasonal, injectable, preservative free" }, "patient" : { "reference" : "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "encounter" : { "reference" : "urn:uuid:e0d01182-27a5-47c9-a4c5-81e5feb3b4cc" }, "date" : "2010-03-01T11:22:41.000Z", "primarySource" : true, "practitioner" : [], "note" : [], "reaction" : [], "vaccinationProtocol" : [] }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Immunization.Read(STU 3)

Description

EXF-FHIR Immunization resource enables the user to retrieve the Immunization details of a patient.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Immunization

Request
http://localhost:8183/STU3/Immunization/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Immunization/43dc845b-76d9-4d23-bab2-904aa85c3162

Structure

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

Response

{ "resourceType": "Immunization", "id": "43dc845b-76d9-4d23-bab2-904aa85c3162", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T15:10:36.980+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Immunization" ] }, "status": "completed", "vaccineCode": { "coding": [ { "system": "http://hl7.org/fhir/sid/cvx", "code": "140", "display": "Influenza, seasonal, injectable, preservative free" } ], "text": "Influenza, seasonal, injectable, preservative free" }, "patient": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "encounter": { "reference": "urn:uuid:e0d01182-27a5-47c9-a4c5-81e5feb3b4cc" }, "date": "2010-03-01T11:22:41+00:00", "primarySource": true }

Immunization.Search(STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Immunization

Request
http://localhost:8183/STU3/Immunization?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Immunization?patient=urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992

Search Parameters

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

Structure

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

Response

{ "resourceType": "Bundle", "id": "df36a330-6612-487d-9491-bb2e960f163a", "meta": { "lastUpdated": "2021-01-29T15:13:50.829+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/Immunization?patient=urn%3Auuid%3Aac3de6f1-e236-4200-b9da-f1b7758de992" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/Immunization/43dc845b-76d9-4d23-bab2-904aa85c3162", "resource": { "resourceType": "Immunization", "id": "43dc845b-76d9-4d23-bab2-904aa85c3162", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T15:10:36.980+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Immunization" ] }, "status": "completed", "vaccineCode": { "coding": [ { "system": "http://hl7.org/fhir/sid/cvx", "code": "140", "display": "Influenza, seasonal, injectable, preservative free" } ], "text": "Influenza, seasonal, injectable, preservative free" }, "patient": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "encounter": { "reference": "urn:uuid:e0d01182-27a5-47c9-a4c5-81e5feb3b4cc" }, "date": "2010-03-01T11:22:41+00:00", "primarySource": true } } ] }

MedicationRequest.Create (STU 3)

Description

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.

General Information

HTTP Method

:

POST

Request URL

:

STU3/MedicationRequest

Request
http://localhost:8183/STU3/MedicationRequest

Content Type

:

application/json

Example

:-

{ "_id" : "87afd33d-751d-4c40-9375-9b8cae9494fc", "resourceType" : "MedicationRequest", "identifier" : [], "definition" : [], "basedOn" : [], "status" : "stopped", "intent" : "order", "medicationCodeableConcept" : { "coding" : [ { "system" : "http://www.nlm.nih.gov/research/umls/rxnorm", "code" : "310965", "display" : "Ibuprofen 200 MG Oral Tablet", "userSelected" : false } ], "text" : "Ibuprofen 200 MG Oral Tablet" }, "subject" : { "reference" : "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context" : { "reference" : "urn:uuid:d6546944-c71d-4f5c-9f35-f401b1f4c24a" }, "supportingInformation" : [], "authoredOn" : "2016-05-21T11:22:41.000Z", "requester" : { "agent" : { "reference" : "urn:uuid:0000016d-3a85-4cca-0000-000000000122" }, "onBehalfOf" : { "reference" : "urn:uuid:8ad64ecf-c817-3753-bee7-006a8e662e06" } }, "reasonCode" : [], "reasonReference" : [], "note" : [], "dosageInstruction" : [ { "sequence" : 1, "additionalInstruction" : [], "asNeededBoolean" : { "_id" : null, "myCoercedValue" : true, "myStringValue" : "true" } } ], "detectedIssue" : [], "eventHistory" : [] }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

MedicationRequest.Read(STU 3)

Description

EXF-FHIR Medication Request resource enables the user to retrieve the Medication Request details of a patient.

General Information

HTTP Method

:

GET

Request URL

:

STU3/MedicationRequest

Request
http://localhost:8183/STU3/MedicationRequest/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/MedicationRequest/87afd33d-751d-4c40-9375-9b8cae9494fc

Structure

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

Response

{ "resourceType": "MedicationRequest", "id": "87afd33d-751d-4c40-9375-9b8cae9494fc", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T14:53:47.539+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/MedicationRequest" ] }, "status": "stopped", "intent": "order", "medicationCodeableConcept": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "310965", "display": "Ibuprofen 200 MG Oral Tablet" } ], "text": "Ibuprofen 200 MG Oral Tablet" }, "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:d6546944-c71d-4f5c-9f35-f401b1f4c24a" }, "authoredOn": "2016-05-21T11:22:41+00:00", "requester": { "agent": { "reference": "urn:uuid:0000016d-3a85-4cca-0000-000000000122" }, "onBehalfOf": { "reference": "urn:uuid:8ad64ecf-c817-3753-bee7-006a8e662e06" } }, "dosageInstruction": [ { "sequence": 1 } ] }

MedicationRequest.Search(STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/MedicationRequest

Request
http://localhost:8183/STU3/MedicationRequest?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/MedicationRequest?patient=urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992

Search Parameters

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

Structure

re report as issued
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

Response

{ "resourceType": "Bundle", "id": "d7a7d409-28f2-4a31-8e88-cdc6da5c7ca2", "meta": { "lastUpdated": "2021-01-29T14:58:21.035+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/MedicationRequest?patient=urn%3Auuid%3Aac3de6f1-e236-4200-b9da-f1b7758de992" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/MedicationRequest/87afd33d-751d-4c40-9375-9b8cae9494fc", "resource": { "resourceType": "MedicationRequest", "id": "87afd33d-751d-4c40-9375-9b8cae9494fc", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T14:53:47.539+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/MedicationRequest" ] }, "status": "stopped", "intent": "order", "medicationCodeableConcept": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "310965", "display": "Ibuprofen 200 MG Oral Tablet" } ], "text": "Ibuprofen 200 MG Oral Tablet" }, "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:d6546944-c71d-4f5c-9f35-f401b1f4c24a" }, "authoredOn": "2016-05-21T11:22:41+00:00", "requester": { "agent": { "reference": "urn:uuid:0000016d-3a85-4cca-0000-000000000122" }, "onBehalfOf": { "reference": "urn:uuid:8ad64ecf-c817-3753-bee7-006a8e662e06" } }, "dosageInstruction": [ { "sequence": 1 } ] } } ] }

Observation.Create (STU 3)

Description

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.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Observation

Request
http://127.0.0.1:8183/STU3/Observation

Content Type

:

application/json

Example

:-

{ "_id" : "2eeb1ee2-459f-435b-a140-2fa2f5d26b63", "resourceType" : "Observation", "identifier" : [], "basedOn" : [], "status" : "final", "category" : [ { "coding" : [ { "system" : "http://hl7.org/fhir/observation-category", "code" : "vital-signs", "display" : "vital-signs", "userSelected" : false } ] } ], "code" : { "coding" : [ { "system" : "http://loinc.org", "code" : "8302-2", "display" : "Body Height", "userSelected" : false } ], "text" : "Body Height" }, "subject" : { "reference" : "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context" : { "reference" : "urn:uuid:e0d01182-27a5-47c9-a4c5-81e5feb3b4cc" }, "effectiveDateTime" : { "_id" : null, "myFractionalSeconds" : "", "myPrecision" : "SECOND", "myTimeZone" : { "_class" : "sun.util.calendar.ZoneInfo", "rawOffset" : -18000000, "rawOffsetDiff" : 0, "checksum" : 0, "dstSavings" : 0, "willGMTOffsetChange" : false, "dirty" : false, "ID" : "GMT-05:00" }, "myTimeZoneZulu" : false, "myCoercedValue" : "2010-03-01T11:22:41.000Z", "myStringValue" : "2010-03-01T06:22:41-05:00" }, "issued" : "2010-03-01T11:22:41.399Z", "performer" : [], "valueQuantity" : { "value" : "173.9018914060253", "unit" : "cm", "system" : "http://unitsofmeasure.org", "code" : "cm" }, "referenceRange" : [], "related" : [], "component" : [] }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Observation.Read(STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Observation

Request
http://localhost:8183/STU3/Observation/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Observation/2eeb1ee2-459f-435b-a140-2fa2f5d26b63

Structure

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

Response

{ "resourceType": "Observation", "id": "2eeb1ee2-459f-435b-a140-2fa2f5d26b63", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T14:45:33.718+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Observation" ] }, "status": "final", "category": [ { "coding": [ { "system": "http://hl7.org/fhir/observation-category", "code": "vital-signs", "display": "vital-signs" } ] } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "8302-2", "display": "Body Height" } ], "text": "Body Height" }, "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "issued": "2010-03-01T11:22:41.399+00:00", "valueQuantity": { "value": 173.9018914060253, "unit": "cm", "system": "http://unitsofmeasure.org", "code": "cm" } }

Observation.Search(STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Observation

Request
http://localhost:8183/STU3/Observation?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Observation?patient=urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992

Search Parameters

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

Structure

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

Response

{ "resourceType": "Bundle", "id": "332597eb-a938-4084-afc0-ace95d5c709c", "meta": { "lastUpdated": "2021-01-29T14:50:08.340+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/Observation?patient=urn%3Auuid%3Aac3de6f1-e236-4200-b9da-f1b7758de992" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/Observation/2eeb1ee2-459f-435b-a140-2fa2f5d26b63", "resource": { "resourceType": "Observation", "id": "2eeb1ee2-459f-435b-a140-2fa2f5d26b63", "meta": { "versionId": "1", "lastUpdated": "2021-01-29T14:45:33.718+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Observation" ] }, "status": "final", "category": [ { "coding": [ { "system": "http://hl7.org/fhir/observation-category", "code": "vital-signs", "display": "vital-signs" } ] } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "8302-2", "display": "Body Height" } ], "text": "Body Height" }, "subject": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "context": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "issued": "2010-03-01T11:22:41.399+00:00", "valueQuantity": { "value": 173.9018914060253, "unit": "cm", "system": "http://unitsofmeasure.org", "code": "cm" } } } ] }

Claim.Create (STU 3)

Description

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.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Claim

Request
http://localhost:8183/STU3/Claim

Content Type

:

application/json

Example

:-

{ "_id" : "fea35dc5-7804-4f84-9401-d3682d9efb56", "resourceType": "Claim", "identifier" : [], "status" : "active", "subType" : [], "use" : "complete", "patient" : { "reference" : "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "billablePeriod" : { "start" : "1965-11-15T11:22:41.000Z", "end" : "1965-11-15T13:07:41.000Z" }, "organization" : { "reference" : "urn:uuid:8ad64ecf-c817-3753-bee7-006a8e662e06" }, "careTeam" : [], "information" : [], "diagnosis" : [ { "sequence" : 1, "diagnosisReference" : { "reference" : "urn:uuid:566d4250-83ff-44fd-81e9-8ed99085f046" }, "type" : [] }, { "sequence" : 2, "diagnosisReference" : { "reference" : "urn:uuid:4d50aaaa-0f7c-4139-9554-482e455d08fa" }, "type" : [] } ], "procedure" : [], "insurance" : [], "item" : [ { "sequence" : 1, "careTeamLinkId" : [], "diagnosisLinkId" : [], "procedureLinkId" : [], "informationLinkId" : [], "modifier" : [], "programCode" : [], "udi" : [], "subSite" : [], "encounter" : [ { "reference" : "urn:uuid:74816842-a979-45a3-b153-d145e253fe4f" } ], "detail" : [] }, { "sequence" : 2, "careTeamLinkId" : [], "diagnosisLinkId" : [ { "_id" : null, "myCoercedValue" : 1, "myStringValue" : "1" } ], "procedureLinkId" : [], "informationLinkId" : [], "modifier" : [], "programCode" : [], "udi" : [], "subSite" : [], "encounter" : [], "detail" : [] }, { "sequence" : 3, "careTeamLinkId" : [], "diagnosisLinkId" : [ { "_id" : null, "myCoercedValue" : 2, "myStringValue" : "2" } ], "procedureLinkId" : [], "informationLinkId" : [], "modifier" : [], "programCode" : [], "udi" : [], "subSite" : [], "encounter" : [], "detail" : [] } ] }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Claim.Read(STU 3)

Description

EXF-FHIR Claim resource enables the user to retrieve the claim details.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Claim

Request
http://localhost:8183/STU3/Claim/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Claim/fea35dc5-7804-4f84-9401-d3682d9efb56

Structure

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

Response

{ "resourceType": "Claim", "id": "6017acd7a4fe9129183dd5e0", "meta": { "versionId": "1", "lastUpdated": "2021-02-01T07:25:11.965+00:00", "profile": [ "https://www.hl7.org/fhir/claim.html" ] }, "status": "active", "use": "complete", "patient": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "billablePeriod": { "start": "1965-11-15T11:22:41+00:00", "end": "1965-11-15T13:07:41+00:00" }, "organization": { "reference": "urn:uuid:8ad64ecf-c817-3753-bee7-006a8e662e06" }, "diagnosis": [ { "sequence": 1, "diagnosisReference": { "reference": "urn:uuid:566d4250-83ff-44fd-81e9-8ed99085f046" } }, { "sequence": 2, "diagnosisReference": { "reference": "urn:uuid:4d50aaaa-0f7c-4139-9554-482e455d08fa" } } ], "item": [ { "sequence": 1, "encounter": [ { "reference": "urn:uuid:74816842-a979-45a3-b153-d145e253fe4f" } ] }, { "sequence": 2 }, { "sequence": 3 } ] }

Claim.Search(STU 3)

Description

EXF-FHIR Claim resource enables the user to retrieve the claim details based on the search parameters like identifier, insurer, organization, etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Claim

Request
http://localhost:8183/STU3/Claim?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Claim?patient=urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992

Search Parameters

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

Structure

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

Response

{ "resourceType": "Bundle", "id": "6d4a5850-0bba-4952-bcfc-3911a3ecaf55", "meta": { "lastUpdated": "2021-02-01T07:26:51.203+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/Claim?patient=urn%3Auuid%3Aac3de6f1-e236-4200-b9da-f1b7758de992" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/Claim/6017acd7a4fe9129183dd5e0", "resource": { "resourceType": "Claim", "id": "6017acd7a4fe9129183dd5e0", "meta": { "versionId": "1", "lastUpdated": "2021-02-01T07:25:11.965+00:00", "profile": [ "https://www.hl7.org/fhir/claim.html" ] }, "status": "active", "use": "complete", "patient": { "reference": "urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992" }, "billablePeriod": { "start": "1965-11-15T11:22:41+00:00", "end": "1965-11-15T13:07:41+00:00" }, "organization": { "reference": "urn:uuid:8ad64ecf-c817-3753-bee7-006a8e662e06" }, "diagnosis": [ { "sequence": 1, "diagnosisReference": { "reference": "urn:uuid:566d4250-83ff-44fd-81e9-8ed99085f046" } }, { "sequence": 2, "diagnosisReference": { "reference": "urn:uuid:4d50aaaa-0f7c-4139-9554-482e455d08fa" } } ], "item": [ { "sequence": 1, "encounter": [ { "reference": "urn:uuid:74816842-a979-45a3-b153-d145e253fe4f" } ] }, { "sequence": 2 }, { "sequence": 3 } ] } } ] }

Goal.Create (STU 3)

Description

EXF-FHIR Goal resource enables the user to create the details of intended objective(s) for a patient, group or organization care.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Goal

Request
http://localhost:8183/STU3/Goal

Content Type

:

application/json

Example

:-

{ "_id" : "1259c7bc-6a5f-41ee-84b0-f3b8c1dd69e2", "resourceType" : "Goal", "identifier" : [], "status" : "in-progress", "category" : [], "description" : { "coding" : [], "text" : "Hemoglobin A1c total in Blood < 7.0" }, "addresses" : [], "note" : [], "outcomeCode" : [], "outcomeReference" : [] }

Structure

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

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Goal.Read(STU 3)

Description

EXF-FHIR Goal resource enables the user to retrieve the details of intended objective(s) for a patient, group or organization care.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Goal

Request
http://localhost:8183/STU3/Goal/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Goal/1259c7bc-6a5f-41ee-84b0-f3b8c1dd69e2

Structure

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

Response

{ "resourceType": "Goal", "id": "1259c7bc-6a5f-41ee-84b0-f3b8c1dd69e2", "meta": { "versionId": "1", "lastUpdated": "2021-02-01T07:18:23.165+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Goal" ] }, "status": "in-progress", "description": { "text": "Hemoglobin A1c total in Blood < 7.0" } }

Goal.Search(STU 3)

Description

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.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Goal

Request
http://localhost:8183/STU3/Goal/SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Goal?_id=1259c7bc-6a5f-41ee-84b0-f3b8c1dd69e2

Search Parameters

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)

Structure

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

Response

{ "resourceType": "Goal", "id": "1259c7bc-6a5f-41ee-84b0-f3b8c1dd69e2", "meta": { "versionId": "1", "lastUpdated": "2021-02-01T07:18:23.165+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Goal" ] }, "status": "in-progress", "description": { "text": "Hemoglobin A1c total in Blood < 7.0" } }

Patient.Create (STU 3)

General Information

HTTP Method

:

POST

Request URL

:

STU3/Patient

Request
http://localhost:8183/STU3/Patient

Content Type

:

application/json

Example

:-

{ "id": "3ba3c41e-ee5d-41f8-9c28-4e8716fec7cc", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/Patient?name=Aaron698" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/Patient/ac3de6f1-e236-4200-b9da-f1b7758de992", "resource": { "resourceType": "Patient", "id": "ac3de6f1-e236-4200-b9da-f1b7758de992", "meta": { "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1" ] }, "identifier": [ { "system": "https://github.com/synthetichealth/synthea", "value": "2fa15bc7-8866-461a-9000-f739e425860a" }, { "system": "http://hospital.smarthealthit.org", "value": "2fa15bc7-8866-461a-9000-f739e425860a" }, { "system": "http://hl7.org/fhir/sid/us-ssn", "value": "999-93-7537" }, { "system": "urn:oid:2.16.840.1.113883.4.3.25", "value": "S99948707" }, { "system": "http://standardhealthrecord.org/fhir/StructureDefinition/passportNumber", "value": "X14078167X" } ], "name": [ { "use": "official", "family": "Brekke496", "given": [ "Aaron698" ], "prefix": [ "Mr." ] } ], "telecom": [ { "system": "phone", "value": "555-677-3119", "use": "home" } ], "gender": "male", "birthDate": "1945-12-10", "address": [ { "line": [ "894 Brakus Bypass" ], "city": "Taunton", "postalCode": "02718" } ] } } ] }

Structure

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

 
Link BackboneElement Link to another patient resource that concerns the same actual person Other Reference(Patient | Related Person) The other patient or related person resource that the link refers to Type Code replaced-by | replaces | refer | see also - type of link

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Patient.Read(STU 3)

This Resource covers data about patients involved in a wide range of health-related activities, including:

  • Curative activities
  • Psychiatric care
  • Social services
  • Pregnancy care
  • Nursing and assisted living
  • Dietary services
  • Tracking of personal health and exercise data

General Information

HTTP Method

:

GET

Request URL

:

STU3/Patient

Request
http://127.0.0.1:8183/STU3/Patient/{ID}

Content Type

:

application/json

Example

:-

http://127.0.0.1:8183/STU3/Patient/3ba3c41e-ee5d-41f8-9c28-4e8716fec7cc

Structure

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

 
Link BackboneElement Link to another patient resource that concerns the same actual person Other Reference(Patient | Related Person) The other patient or related person resource that the link refers to Type Code replaced-by | replaces | refer | see also - type of link

Response

{ "id": "3ba3c41e-ee5d-41f8-9c28-4e8716fec7cc", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/Patient?name=Aaron698" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/Patient/ac3de6f1-e236-4200-b9da-f1b7758de992", "resource": { "resourceType": "Patient", "id": "ac3de6f1-e236-4200-b9da-f1b7758de992", "meta": { "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1" ] }, "identifier": [ { "system": "https://github.com/synthetichealth/synthea", "value": "2fa15bc7-8866-461a-9000-f739e425860a" }, { "system": "http://hospital.smarthealthit.org", "value": "2fa15bc7-8866-461a-9000-f739e425860a" }, { "system": "http://hl7.org/fhir/sid/us-ssn", "value": "999-93-7537" }, { "system": "urn:oid:2.16.840.1.113883.4.3.25", "value": "S99948707" }, { "system": "http://standardhealthrecord.org/fhir/StructureDefinition/passportNumber", "value": "X14078167X" } ], "name": [ { "use": "official", "family": "Brekke496", "given": [ "Aaron698" ], "prefix": [ "Mr." ] } ], "telecom": [ { "system": "phone", "value": "555-677-3119", "use": "home" } ], "gender": "male", "birthDate": "1945-12-10", "address": [ { "line": [ "894 Brakus Bypass" ], "city": "Taunton", "postalCode": "02718" } ] } } ] }

Patient.Search(STU 3)

This Resource covers data about patients involved in a wide range of health-related activities, including:

  • Curative activities
  • Psychiatric care
  • Social services
  • Pregnancy care
  • Nursing and assisted living
  • Dietary services
  • Tracking of personal health and exercise data

General Information

HTTP Method

:

GET

Request URL

:

STU3/Patient

Request
http://localhost:8183/STU3/Patient?name=Aaron698

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/DiagnosticReport?patient=urn:uuid:ac3de6f1-e236-4200-b9da-f1b7758de992

Search Parameters

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

Structure

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

 
Link BackboneElement Link to another patient resource that concerns the same actual person Other Reference(Patient | Related Person) The other patient or related person resource that the link refers to Type Code replaced-by | replaces | refer | see also - type of link

Response

{ "resourceType": "Bundle", "id": "3ba3c41e-ee5d-41f8-9c28-4e8716fec7cc", "meta": { "lastUpdated": "2021-01-20T11:50:49.868+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://localhost:8183/STU3/Patient?name=Aaron698" } ], "entry": [ { "fullUrl": "http://localhost:8183/STU3/Patient/ac3de6f1-e236-4200-b9da-f1b7758de992", "resource": { "resourceType": "Patient", "id": "ac3de6f1-e236-4200-b9da-f1b7758de992", "meta": { "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1" ] }, "identifier": [ { "system": "https://github.com/synthetichealth/synthea", "value": "2fa15bc7-8866-461a-9000-f739e425860a" }, { "system": "http://hospital.smarthealthit.org", "value": "2fa15bc7-8866-461a-9000-f739e425860a" }, { "system": "http://hl7.org/fhir/sid/us-ssn", "value": "999-93-7537" }, { "system": "urn:oid:2.16.840.1.113883.4.3.25", "value": "S99948707" }, { "system": "http://standardhealthrecord.org/fhir/StructureDefinition/passportNumber", "value": "X14078167X" } ], "name": [ { "use": "official", "family": "Brekke496", "given": [ "Aaron698" ], "prefix": [ "Mr." ] } ], "telecom": [ { "system": "phone", "value": "555-677-3119", "use": "home" } ], "gender": "male", "birthDate": "1945-12-10", "address": [ { "line": [ "894 Brakus Bypass" ], "city": "Taunton", "postalCode": "02718" } ] } } ] }

Device.Create(STU 3)

Description

EXF-FHIR Device resource enables the user to identify the type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Device

Request
http://127.0.0.1:8183/STU3/Device?_id=123456

Content Type

:

application/json

Example

:-

{ "resourceType": "Device", "text": { "status": "generated" }, "identifier": [ { "system": "http://goodcare.org/devices/id", "value": "345675" }, { "type": { "coding": [ { "system": "http://hl7.org/fhir/identifier-type", "code": "SNO" } ], "text": "Serial Number" }, "value": "AMID-342135-8464" } ], "status": "active", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "86184003", "display": "Electrocardiographic monitor and recorder" } ], "text": "ECG" }, "lotNumber": "43453424", "manufacturer": "Acme Devices, Inc", "model": "AB 45-J", "contact": [ { "system": "phone", "value": "ext 4352" } ], "note": [ { "authorReference": { "reference": "Practitioner/xcda-author" }, "time": "2015-06-28T14:03:32+10:00", "text": "QA Checked" } ] }

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
udi UDI Unique Device Identifier (UDI) Barcode string
status String Status of the device
type CodeableConcept Kind of organization
lotNumber String Lot Number of manufacture
manufacturer String Name of device manufacturer
manufacturerDate DateTime Date when the device was made
expirationDate DateTime Date and time of expiry of this device (if applicable)
partOf Reference(Organization) The organization of which this organization forms a part
model String Model id assigned by the manufacturer
version String Version number (i.e. software)
patient Reference Patient to whom Device is affixed
owner Reference Organization responsible for device
contact ContactPoint Details for human/organization for support
location Reference Where the resource is found
url uri Network address to contact device
note Annotation Device notes and comments
safety CodeableConcept Safety Characteristics of Device

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Device.Read(STU3)

Description

EXF-FHIR Device resource enables the user to retrieve the details of a Device.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Device

Request
http://localhost:8183/STU3/Device/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Device/123456

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
udi UDI Unique Device Identifier (UDI) Barcode string
status String Status of the device
type CodeableConcept Kind of organization
lotNumber String Lot Number of manufacture
manufacturer String Name of device manufacturer
manufacturerDate DateTime Date when the device was made
expirationDate DateTime Date and time of expiry of this device (if applicable)
partOf Reference(Organization) The organization of which this organization forms a part
model String Model id assigned by the manufacturer
version String Version number (i.e. software)
patient Reference Patient to whom Device is affixed
owner Reference Organization responsible for device
contact ContactPoint Details for human/organization for support
location Reference Where the resource is found
url uri Network address to contact device
note Annotation Device notes and comments
safety CodeableConcept Safety Characteristics of Device

Response

{ "resourceType": "Device", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T17:28:34.287+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Device" ] }, "identifier": [ { "system": "http://goodcare.org/devices/id", "value": "345675" }, { "type": { "coding": [ { "system": "http://hl7.org/fhir/identifier-type", "code": "SNO" } ], "text": "Serial Number" }, "value": "AMID-342135-8464" } ], "status": "active", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "86184003", "display": "Electrocardiographic monitor and recorder" } ], "text": "ECG" }, "lotNumber": "43453424", "manufacturer": "Acme Devices, Inc", "model": "AB 45-J", "contact": [ { "system": "phone", "value": "ext 4352" } ], "note": [ { "authorReference": { "reference": "Practitioner/xcda-author" }, "text": "QA Checked" } ] }

Device.Search(STU 3)

Description

EXF-FHIR Device resource enables the user to retrieve the required details of a device based on the search parameters like identifiers, status etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Device

Request
http://localhost:8183/STU3/Device?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Device?status=ACTIVE

Search Parameters

Name Type Expression
device-name String Device.udi.name | Device.type.text | Device.type.coding.display
location reference Device.location
manufacturer String Device.manufacturer
model String Device.model
organization reference Device.owner
Identifier Token Device.identifier
patient reference Device.patient
status Token Device.status
type Token Device.type
udi-carrier string Device.udi.carrierHRF | Device.udi.carrierAIDC
udi-di string Device.udi.deviceIdentifier
url uri Device.url

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
udi UDI Unique Device Identifier (UDI) Barcode string
status String Status of the device
type CodeableConcept Kind of organization
lotNumber String Lot Number of manufacture
manufacturer String Name of device manufacturer
manufacturerDate DateTime Date when the device was made
expirationDate DateTime Date and time of expiry of this device (if applicable)
partOf Reference(Organization) The organization of which this organization forms a part
model String Model id assigned by the manufacturer
version String Version number (i.e. software)
patient Reference Patient to whom Device is affixed
owner Reference Organization responsible for device
contact ContactPoint Details for human/organization for support
location Reference Where the resource is found
url uri Network address to contact device
note Annotation Device notes and comments
safety CodeableConcept Safety Characteristics of Device

Response

{ "resourceType": "Bundle", "id": "478438d8-5edc-4d69-86be-8f3e4314e28a", "meta": { "lastUpdated": "2021-06-07T17:46:52.910+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://fhirserver.exafluence.com/STU3/Device?status=ACTIVE" } ], "entry": [ { "fullUrl": "http://fhirserver.exafluence.com/STU3/Device/123456", "resource": { "resourceType": "Device", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T17:28:34.287+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Device" ] }, "identifier": [ { "system": "http://goodcare.org/devices/id", "value": "345675" }, { "type": { "coding": [ { "system": "http://hl7.org/fhir/identifier-type", "code": "SNO" } ], "text": "Serial Number" }, "value": "AMID-342135-8464" } ], "status": "active", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "86184003", "display": "Electrocardiographic monitor and recorder" } ], "text": "ECG" }, "lotNumber": "43453424", "manufacturer": "Acme Devices, Inc", "model": "AB 45-J", "contact": [ { "system": "phone", "value": "ext 4352" } ], "note": [ { "authorReference": { "reference": "Practitioner/xcda-author" }, "text": "QA Checked" } ] } } ] }

Procedure.Create(STU 3)

Description

EXF-FHIR Procedure resource refers to an action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy

General Information

HTTP Method

:

POST

Request URL

:

STU3/Procedure

Request
http://127.0.0.1:8183/STU3/Procedure

Content Type

:

application/json

Example

:-

{ "resourceType": "Procedure", "id": "example", "text": { "status": "generated" }, "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "80146002", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "subject": { "reference": "Patient/example" }, "performedDateTime": "2013-04-05", "performer": [ { "actor": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" } } ], "reasonCode": [ { "text": "Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding" } ], "followUp": [ { "text": "ROS 5 days - 2013-04-10" } ], "note": [ { "text": "Routine Appendectomy. Appendix was inflamed and in retro-caecal position" } ] }

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
definition Reference Instantiates protocol or definition
basedOn Reference A request for this procedure
partOf Reference Part of referenced event
status String status of the procedure
notDone boolean True if procedure was not performed as scheduled
notDoneReason CodeableConcept Reason procedure was not performed
category CodeableConcept(Organization) Classification of the procedure
code CodeableConcept Identification of the procedure
subject Reference Who the procedure was performed on
context Reference Encounter or episode associated with the procedure
performed[x] Date/Period Date/Period the procedure was performed.
performer Performer The people who performed the procedure
location Reference Where the procedure happened
reason CodeableConcept Coded reason procedure performed
reasonReference Reference Condition that is the reason the procedure performed
bodySite CodeableConcept Target body sites
outcome CodeableConcept The result of procedure
report Reference Any report resulting from the procedure
complication CodeableConcept Complication following the procedure
complicationDetail Reference A condition that is a result of the procedure
followUp CodeableConcept Instructions for follow up
note Annotation Additional information about the procedure
focalDevice FocalDevice Device changed in procedure
usedReference Reference Items used during procedure
usedCode CodeableConcept Coded items used during the procedure

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Procedure.Read(STU 3)

Description

EXF-FHIR Procedure resource enables the user to retrieve the details of a Procedure.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Procedure

Request
http://localhost:8183/STU3/Procedure/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Procedure/123456

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
definition Reference Instantiates protocol or definition
basedOn Reference A request for this procedure
partOf Reference Part of referenced event
status String status of the procedure
notDone boolean True if procedure was not performed as scheduled
notDoneReason CodeableConcept Reason procedure was not performed
category CodeableConcept(Organization) Classification of the procedure
code CodeableConcept Identification of the procedure
subject Reference Who the procedure was performed on
context Reference Encounter or episode associated with the procedure
performed[x] Date/Period Date/Period the procedure was performed.
performer Performer The people who performed the procedure
location Reference Where the procedure happened
reason CodeableConcept Coded reason procedure performed
reasonReference Reference Condition that is the reason the procedure performed
bodySite CodeableConcept Target body sites
outcome CodeableConcept The result of procedure
report Reference Any report resulting from the procedure
complication CodeableConcept Complication following the procedure
complicationDetail Reference A condition that is a result of the procedure
followUp CodeableConcept Instructions for follow up
note Annotation Additional information about the procedure
focalDevice FocalDevice Device changed in procedure
usedReference Reference Items used during procedure
usedCode CodeableConcept Coded items used during the procedure

Response

{ "resourceType": "Procedure", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T17:49:27.267+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Procedure" ] }, "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "80146002", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "subject": { "reference": "Patient/example" }, "performedDateTime": "2013-04-05", "performer": [ { "actor": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" } } ], "reasonCode": [ { "text": "Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding" } ], "followUp": [ { "text": "ROS 5 days - 2013-04-10" } ], "note": [ { "text": "Routine Appendectomy. Appendix was inflamed and in retro-caecal position" } ] }

Procedure.Search(STU 3)

Description

EXF-FHIR Procedure resource enables the user to retrieve the required details of an Procedure based on the search parameters like identifiers, status etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Procedure

Request
http://localhost:8183/STU3/Procedure?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Procedure?status=COMPLETED

Search Parameters

Name Type Expression
based-on reference Procedure.basedOn
category token Procedure.category
code token Procedure.code
context reference Procedure.context
date date Procedure.performed
Identifier Token Procedure.identifier
definition reference Procedure.definition
encounter reference Procedure.context
location reference Procedure.location
part-of reference Procedure.partOf
patient reference Procedure.subject
performer reference Procedure.performer.actor
status token Procedure.status
subject reference Procedure.subject

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
definition Reference Instantiates protocol or definition
basedOn Reference A request for this procedure
partOf Reference Part of referenced event
status String status of the procedure
notDone boolean True if procedure was not performed as scheduled
notDoneReason CodeableConcept Reason procedure was not performed
category CodeableConcept(Organization) Classification of the procedure
code CodeableConcept Identification of the procedure
subject Reference Who the procedure was performed on
context Reference Encounter or episode associated with the procedure
performed[x] Date/Period Date/Period the procedure was performed.
performer Performer The people who performed the procedure
location Reference Where the procedure happened
reason CodeableConcept Coded reason procedure performed
reasonReference Reference Condition that is the reason the procedure performed
bodySite CodeableConcept Target body sites
outcome CodeableConcept The result of procedure
report Reference Any report resulting from the procedure
complication CodeableConcept Complication following the procedure
complicationDetail Reference A condition that is a result of the procedure
followUp CodeableConcept Instructions for follow up
note Annotation Additional information about the procedure
focalDevice FocalDevice Device changed in procedure
usedReference Reference Items used during procedure
usedCode CodeableConcept Coded items used during the procedure

Response

{ "resourceType": "Bundle", "id": "5dc93937-f620-4dc7-b6a0-fc45514197b4", "meta": { "lastUpdated": "2021-06-07T17:51:15.994+00:00" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "http://fhirserver.exafluence.com/STU3/Procedure?status=COMPLETED" } ], "entry": [ { "fullUrl": "http://fhirserver.exafluence.com/STU3/Procedure/12345", "resource": { "resourceType": "Procedure", "id": "12345", "meta": { "versionId": "2", "lastUpdated": "2021-05-17T15:40:33.224+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Procedure" ] }, "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "80146002", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "subject": { "reference": "Patient/example" }, "performedDateTime": "2021-11-11", "performer": [ { "actor": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" } } ], "reasonCode": [ { "text": "Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding" } ], "followUp": [ { "text": "ROS 5 days - 2013-04-10" } ], "note": [ { "text": "Routine Appendectomy. Appendix was inflamed and in retro-caecal position" } ] } }, { "fullUrl": "http://fhirserver.exafluence.com/STU3/Procedure/123456", "resource": { "resourceType": "Procedure", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T17:49:27.267+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Procedure" ] }, "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "80146002", "display": "Appendectomy (Procedure)" } ], "text": "Appendectomy" }, "subject": { "reference": "Patient/example" }, "performedDateTime": "2013-04-05", "performer": [ { "actor": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" } } ], "reasonCode": [ { "text": "Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding" } ], "followUp": [ { "text": "ROS 5 days - 2013-04-10" } ], "note": [ { "text": "Routine Appendectomy. Appendix was inflamed and in retro-caecal position" } ] } } ] }

Substance.Create(STU 3)

Description

EXF-FHIR Substance resource type allows for a material to be represented. The resource can be used to represent either a kind of a substance - e.g. a formulation commonly used for treating patients, or it can be used to describe a particular package of a known substance (e.g. bottle, jar, packet).

General Information

HTTP Method

:

POST

Request URL

:

STU3/Substance

Request
http://127.0.0.1:8183/STU3/Substance

Content Type

:

application/json

Example

:-

{ "resourceType": "Substance", "id": "example", "text": { "status": "generated" }, "identifier": [ { "system": "http://acme.org/identifiers/substances", "value": "1463" } ], "status": "active", "category": [ { "coding": [ { "system": "http://hl7.org.fhir/substance-category", "code": "allergen", "display": "Allergen" } ] } ], "code": { "text": "apitoxin (Honey Bee Venom)" } }

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
status string status of the susbstance
category CodeableConcept What class/type of substance this is
code CodeableConcept What substance this is
description String Textual description of the substance, comments
instance Instance If this describes a specific package/container of the substance
ingredient Ingredient Composition information about the substance

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Substance.Read(STU 3)

Description

EXF-FHIR Substance resource enables the user to retrieve the details of a Substance.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Substance

Request
http://localhost:8183/STU3/Substance/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Substance/123456

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
status string status of the susbstance
category CodeableConcept What class/type of substance this is
code CodeableConcept What substance this is
description String Textual description of the substance, comments
instance Instance If this describes a specific package/container of the substance
ingredient Ingredient Composition information about the substance

Response

{ "resourceType": "Substance", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T17:54:02.610+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Substance" ] }, "identifier": [ { "system": "http://acme.org/identifiers/substances", "value": "1463" } ], "status": "active", "category": [ { "coding": [ { "system": "http://hl7.org.fhir/substance-category", "code": "allergen", "display": "Allergen" } ] } ], "code": { "text": "apitoxin (Honey Bee Venom)" } }

Substance.Search(STU 3)

Description

EXF-FHIR Substance resource enables the user to retrieve the required details of an Substance based on the search parameters like identifiers, status etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Substance

Request
http://localhost:8183/STU3/Substance?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Substance?status=ACTIVE

Search Parameters

Name Type Expression
category Token Substance.category
code token Substance.code | Substance.ingredient.substance.as(CodeableConcept)
container-identifier token Substance.instance.identifier
expiry date Substance.instance.expiry
quantity quantity Substance.instance.quantity
Identifier Token Substance.identifier
status String Substance.status
substance-reference reference Substance.ingredient.substance.as(Reference)

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
status string status of the susbstance
category CodeableConcept What class/type of substance this is
code CodeableConcept What substance this is
description String Textual description of the substance, comments
instance Instance If this describes a specific package/container of the substance
ingredient Ingredient Composition information about the substance

Response

{ "resourceType": "Bundle", "id": "5d4c919a-92f5-45a4-b5ff-b2f5b898f7b3", "meta": { "lastUpdated": "2021-06-07T17:56:07.522+00:00" }, "type": "searchset", "total": 3, "link": [ { "relation": "self", "url": "http://fhirserver.exafluence.com/STU3/Substance?status=ACTIVE" } ], "entry": [ { "fullUrl": "http://fhirserver.exafluence.com/STU3/Substance/12345", "resource": { "resourceType": "Substance", "id": "12345", "meta": { "versionId": "2", "lastUpdated": "2021-05-19T12:18:28.944+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Substance" ] }, "identifier": [ { "system": "http://acme.org/identifiers/substances", "value": "14" } ], "status": "active", "category": [ { "coding": [ { "system": "http://hl7.org.fhir/substance-category", "code": "allergen", "display": "Allergen" } ] } ], "code": { "text": "apitoxin (Honey Bee Venom)" } } }, { "fullUrl": "http://fhirserver.exafluence.com/STU3/Substance/231351KJbk-42asx435a4-asc534", "resource": { "resourceType": "Substance", "id": "231351KJbk-42asx435a4-asc534", "meta": { "versionId": "2", "lastUpdated": "2021-06-01T07:56:14.209+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Substance" ] }, "identifier": [ { "use": "official", "type": { "coding": [ { "code": "1463" } ] }, "system": "http://acme.org/identifiers/substances", "value": "231351KJbk-42asx435a4-asc534" } ], "status": "active", "category": [ { "coding": [ { "system": "http://hl7.org.fhir/substance-category", "code": "allergen", "display": "Allergen" } ], "text": "apitoxin (Honey Bee Venom)" } ] } }, { "fullUrl": "http://fhirserver.exafluence.com/STU3/Substance/123456", "resource": { "resourceType": "Substance", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T17:54:02.610+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Substance" ] }, "identifier": [ { "system": "http://acme.org/identifiers/substances", "value": "1463" } ], "status": "active", "category": [ { "coding": [ { "system": "http://hl7.org.fhir/substance-category", "code": "allergen", "display": "Allergen" } ] } ], "code": { "text": "apitoxin (Honey Bee Venom)" } } } ] }

HealthcareService.Create(STU 3)

Description

EXF-FHIR HealthcareService resource is used to describe a single healthcare service or category of services that are provided by an organization at a location.

General Information

HTTP Method

:

POST

Request URL

:

STU3/HealthcareService

Request
http://127.0.0.1:8183/STU3/HealthcareService

Content Type

:

application/json

Example

:-

{ "resourceType": "HealthcareService", "id": "example", "text": { "status": "generated" }, "contained": [ { "resourceType": "Location", "id": "DenBurg", "description": "Greater Denburg area", "mode": "instance", "physicalType": { "coding": [ { "code": "area", "display": "Area" } ] } } ], "identifier": [ { "system": "http://example.org/shared-ids", "value": "HS-12" } ], "active": true, "providedBy": { "reference": "Organization/f001", "display": "Burgers University Medical Center" }, "category": { "coding": [ { "system": "http://hl7.org/fhir/service-category", "code": "8", "display": "Counselling" } ], "text": "Counselling" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "394913002", "display": "Psychotherapy" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "394587001", "display": "Psychiatry" } ] } ], "specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "47505003", "display": "Posttraumatic stress disorder" } ] } ], "location": [ { "reference": "Location/1" } ], "name": "Consulting psychologists and/or psychology services", "comment": "Providing Specialist psychology services to the greater Den Burg area, many years of experience dealing with PTSD issues", "extraDetails": "Several assessments are required for these specialist services, and the waiting times can be greater than 3 months at times. Existing patients are prioritized when requesting appointments on the schedule.", "telecom": [ { "system": "phone", "value": "(555) silent", "use": "work" }, { "system": "email", "value": "directaddress@example.com", "use": "work" } ], "coverageArea": [ { "reference": "#DenBurg", "display": "Greater Denburg area" } ], "serviceProvisionCode": [ { "coding": [ { "system": "http://hl7.org/fhir/service-provision-conditions", "code": "cost", "display": "Fees apply" } ] } ], "eligibility": { "coding": [ { "display": "DVA Required" } ] }, "eligibilityNote": "Evidence of application for DVA status may be sufficient for commencing assessment", "programName": [ "PTSD outreach" ], "characteristic": [ { "coding": [ { "display": "Wheelchair access" } ] } ], "referralMethod": [ { "coding": [ { "code": "phone", "display": "Phone" } ] }, { "coding": [ { "code": "fax", "display": "Fax" } ] }, { "coding": [ { "code": "elec", "display": "Secure Messaging" } ] }, { "coding": [ { "code": "semail", "display": "Secure Email" } ] } ], "appointmentRequired": false, "availableTime": [ { "daysOfWeek": [ "wed" ], "allDay": true }, { "daysOfWeek": [ "mon", "tue", "thu", "fri" ], "availableStartTime": "08:30:00", "availableEndTime": "05:30:00" }, { "daysOfWeek": [ "sat", "fri" ], "availableStartTime": "09:30:00", "availableEndTime": "04:30:00" } ], "notAvailable": [ { "description": "Christmas/Boxing Day", "during": { "start": "2015-12-25", "end": "2015-12-26" } }, { "description": "New Years Day", "during": { "start": "2016-01-01", "end": "2016-01-01" } } ], "availabilityExceptions": "Reduced capacity is available during the Christmas period", "endpoint": [ { "reference": "Endpoint/example" } ] }

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
Active boolean Whether this healthcareservice is in active use
providedBy Reference Organization that provides this service
category CodeableConcept Broad category of service being performed or delivered
type CodeableConcept Type of service that may be delivered or performed
speciality CodeableConcept Specialties handled by the HealthcareService
location Reference Location(s) where service may be provided
name String Description of service as presented to a consumer while searching
comment String Additional description and/or any specific issues not covered elsewhere
extraDetails string Extra details about the service that can't be placed in the other fields
photo Attachment Facilitates quick identification of the service
telecom ContactPoint Contacts related to the healthcare service
coverageArea Reference Location(s) service is inteded for/available to
serviceProvisionCode CodeableConcept Conditions under which service is available/offered
eligibility CodeableConcept Specific eligibility requirements required to use the service
eligibilityNote string Describes the eligibility conditions for the service
programNote string Program Names that categorize the service
characteristic CodeableConcept Collection of characteristics (attributes)
referralMethod CodeableConcept Ways that the service accepts referrals
appointmentRequired boolean If an appointment is required for access to this service
availableTime AvailableTime Times the Service Site is available
notAvailable NotAvailable Not available during this time due to provided reason
availabilityExceptions string Description of availability exceptions
endPoint Reference Technical endpoints providing access to services operated for the location

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

HealthcareService.Read(STU 3)

Description

EXF-FHIR HealthcareService resource enables the user to retrieve the details of a HealthcareService.

General Information

HTTP Method

:

GET

Request URL

:

STU3/HealthcareService

Request
http://localhost:8183/STU3/HealthcareService/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/HealthcareService/123456

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
Active boolean Whether this healthcareservice is in active use
providedBy Reference Organization that provides this service
category CodeableConcept Broad category of service being performed or delivered
type CodeableConcept Type of service that may be delivered or performed
speciality CodeableConcept Specialties handled by the HealthcareService
location Reference Location(s) where service may be provided
name String Description of service as presented to a consumer while searching
comment String Additional description and/or any specific issues not covered elsewhere
extraDetails string Extra details about the service that can't be placed in the other fields
photo Attachment Facilitates quick identification of the service
telecom ContactPoint Contacts related to the healthcare service
coverageArea Reference Location(s) service is inteded for/available to
serviceProvisionCode CodeableConcept Conditions under which service is available/offered
eligibility CodeableConcept Specific eligibility requirements required to use the service
eligibilityNote string Describes the eligibility conditions for the service
programNote string Program Names that categorize the service
characteristic CodeableConcept Collection of characteristics (attributes)
referralMethod CodeableConcept Ways that the service accepts referrals
appointmentRequired boolean If an appointment is required for access to this service
availableTime AvailableTime Times the Service Site is available
notAvailable NotAvailable Not available during this time due to provided reason
availabilityExceptions string Description of availability exceptions
endPoint Reference Technical endpoints providing access to services operated for the location

Response

{ "resourceType": "HealthcareService", "id": "23165462132-351321-213513", "meta": { "versionId": "6", "lastUpdated": "2021-06-03T10:41:57.651+00:00", "profile": [ "http://hl7.org/fhir/stu3/healthcareservice.html" ] } }

HealthcareService.Search(STU 3)

Description

EXF-FHIR HealthcareService resource enables the user to retrieve the required details of a HealthcareService based on the search parameters like identifiers, active etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/HealthcareService

Request
http://localhost:8183/STU3/HealthcareService?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/HealthcareService?active=TRUE

Search Parameters

Name Type Expression
active Token HealthcareService.active
category token HealthcareService.category
characteristic token HealthcareService.characteristic
endpoint reference HealthcareService.endpoint
location reference HealthcareService.location
Identifier Token HealthcareService.identifier
name String HealthcareService.name
organization reference HealthcareService.providedBy
programname string HealthcareService.programName
type token HealthcareService.type

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
Active boolean Whether this healthcareservice is in active use
providedBy Reference Organization that provides this service
category CodeableConcept Broad category of service being performed or delivered
type CodeableConcept Type of service that may be delivered or performed
speciality CodeableConcept Specialties handled by the HealthcareService
location Reference Location(s) where service may be provided
name String Description of service as presented to a consumer while searching
comment String Additional description and/or any specific issues not covered elsewhere
extraDetails string Extra details about the service that can't be placed in the other fields
photo Attachment Facilitates quick identification of the service
telecom ContactPoint Contacts related to the healthcare service
coverageArea Reference Location(s) service is inteded for/available to
serviceProvisionCode CodeableConcept Conditions under which service is available/offered
eligibility CodeableConcept Specific eligibility requirements required to use the service
eligibilityNote string Describes the eligibility conditions for the service
programNote string Program Names that categorize the service
characteristic CodeableConcept Collection of characteristics (attributes)
referralMethod CodeableConcept Ways that the service accepts referrals
appointmentRequired boolean If an appointment is required for access to this service
availableTime AvailableTime Times the Service Site is available
notAvailable NotAvailable Not available during this time due to provided reason
availabilityExceptions string Description of availability exceptions
endPoint Reference Technical endpoints providing access to services operated for the location

Response

{ "resourceType": "Bundle", "id": "68988ec3-5eb5-4507-9990-7215201f9b6c", "meta": { "lastUpdated": "2021-06-08T14:14:55.111+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://fhirserver.exafluence.com/STU3/HealthcareService?active=TRUE" } ], "entry" : [ { "resourceType": "HealthcareService", "id": "23165462132-351321-213513", "meta": { "versionId": "6", "lastUpdated": "2021-06-03T10:41:57.651+00:00", "profile": [ "http://hl7.org/fhir/stu3/healthcareservice.html" ] } }] }

EpisodeofCare.Create(STU 3)

Description

EXF-FHIR EpisodeOfCare resource contains information about an association of a Patient with a Healthcare Provider for a period of time under which related healthcare activities may occur.

General Information

HTTP Method

:

POST

Request URL

:

STU3/EpisodeOfCare

Request
http://127.0.0.1:8183/STU3/EpisodeOfCare

Content Type

:

application/json

Example

:-

{ "resourceType": "EpisodeOfCare", "id": "example", "text": { "status": "generated" }, "identifier": [ { "system": "http://example.org/sampleepisodeofcare-identifier", "value": "123" } ], "status": "active", "statusHistory": [ { "status": "planned", "period": { "start": "2014-09-01", "end": "2014-09-14" } }, { "status": "active", "period": { "start": "2014-09-15", "end": "2014-09-21" } }, { "status": "onhold", "period": { "start": "2014-09-22", "end": "2014-09-24" } }, { "status": "active", "period": { "start": "2014-09-25" } } ], "type": [ { "coding": [ { "system": "http://hl7.org/fhir/episodeofcare-type", "code": "hacc", "display": "Home and Community Care" } ] } ], "diagnosis": [ { "condition": { "reference": "Condition/stroke" }, "role": { "coding": [ { "system": "http://hl7.org/fhir/diagnosis-role", "code": "CC", "display": "Chief complaint" } ] }, "rank": 1 } ], "patient": { "reference": "Patient/example" }, "managingOrganization": { "reference": "Organization/hl7" }, "period": { "start": "2014-09-01" }, "referralRequest": [ { "display": "Referral from Example Aged Care Services" } ], "careManager": { "reference": "Practitioner/14", "display": "Amanda Assigned" }, "team": [ { "reference": "CareTeam/example", "display": "example care team" } ], "account": [ { "reference": "Account/example", "display": "example account" } ] }

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
status string Describes the status
statusHistory StatusHistory Past list of status codes (the current status may be included to cover the start date of the status)
type CodeableConcept Type/class - e.g. specialist referral, disease management
diagnosis Diagnosis The list of diagnosis relevant to this episode of care
patient Reference The patient who is the focus of this episode of care
managingOrganization Reference Organization that assumes care
period Period Interval during responsibility is assumed
referralRequest Reference Originating Referral Request(s)
careManager Reference Care manager/care co-ordinator for the patient
team Reference Other practitioners facilitating this episode of care
account Reference The set of accounts that may be used for billing for this EpisodeOfCare

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

EpisodeofCare.Read(STU 3)

Description

EXF-FHIR EpisodeofCare resource enables the user to retrieve the details of an EpisodeofCare.

General Information

HTTP Method

:

GET

Request URL

:

STU3/EpisodeofCare

Request
http://localhost:8183/STU3/EpisodeOfCare/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/EpisodeOfCare/123456

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
status string Describes the status
statusHistory StatusHistory Past list of status codes (the current status may be included to cover the start date of the status)
type CodeableConcept Type/class - e.g. specialist referral, disease management
diagnosis Diagnosis The list of diagnosis relevant to this episode of care
patient Reference The patient who is the focus of this episode of care
managingOrganization Reference Organization that assumes care
period Period Interval during responsibility is assumed
referralRequest Reference Originating Referral Request(s)
careManager Reference Care manager/care co-ordinator for the patient
team Reference Other practitioners facilitating this episode of care
account Reference The set of accounts that may be used for billing for this EpisodeOfCare

Response

{ "resourceType": "EpisodeOfCare", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T18:04:06.729+00:00", "profile": [ "http://hl7.org/fhir/stu3/episodeofcare.html" ] }, "identifier": [ { "system": "http://example.org/sampleepisodeofcare-identifier", "value": "123" } ], "status": "active", "statusHistory": [ { "status": "planned", "period": { "start": "2014-09-01T00:00:00+00:00", "end": "2014-09-14T00:00:00+00:00" } }, { "status": "active", "period": { "start": "2014-09-15T00:00:00+00:00", "end": "2014-09-21T00:00:00+00:00" } }, { "status": "onhold", "period": { "start": "2014-09-22T00:00:00+00:00", "end": "2014-09-24T00:00:00+00:00" } }, { "status": "active", "period": { "start": "2014-09-25T00:00:00+00:00" } } ], "type": [ { "coding": [ { "system": "http://hl7.org/fhir/episodeofcare-type", "code": "hacc", "display": "Home and Community Care" } ] } ], "diagnosis": [ { "condition": { "reference": "Condition/stroke" }, "role": { "coding": [ { "system": "http://hl7.org/fhir/diagnosis-role", "code": "CC", "display": "Chief complaint" } ] }, "rank": 1 } ], "patient": { "reference": "Patient/example" }, "managingOrganization": { "reference": "Patient/example" }, "period": { "start": "2014-09-01T00:00:00+00:00" }, "referralRequest": [ { "display": "Referral from Example Aged Care Services" } ], "careManager": { "reference": "Practitioner/14", "display": "Amanda Assigned" }, "team": [ { "reference": "CareTeam/example", "display": "example care team" } ], "account": [ { "reference": "Account/example", "display": "example account" } ] }

EpisodeofCare.Search(STU 3)

Description

EXF-FHIR EpisodeofCare resource enables the user to retrieve the required details of an EpisodeofCare based on the search parameters like identifiers, status etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/EpisodeofCare

Request
http://localhost:8183/STU3/EpisodeofCare?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/EpisodeofCare?status=ACTIVE

Search Parameters

Name Type Expression
care-manager reference EpisodeOfCare.careManager
condition reference EpisodeOfCare.diagnosis.condition
date date EpisodeOfCare.period
incomingreferral reference EpisodeOfCare.referralRequest
organization reference EpisodeOfCare.managingOrganization
Identifier Token EpisodeOfCare.identifier
patient reference EpisodeOfCare.patient
status Token EpisodeOfCare.status
type Token EpisodeOfCare.type

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
status string Describes the status
statusHistory StatusHistory Past list of status codes (the current status may be included to cover the start date of the status)
type CodeableConcept Type/class - e.g. specialist referral, disease management
diagnosis Diagnosis The list of diagnosis relevant to this episode of care
patient Reference The patient who is the focus of this episode of care
managingOrganization Reference Organization that assumes care
period Period Interval during responsibility is assumed
referralRequest Reference Originating Referral Request(s)
careManager Reference Care manager/care co-ordinator for the patient
team Reference Other practitioners facilitating this episode of care
account Reference The set of accounts that may be used for billing for this EpisodeOfCare

Response

{ "resourceType": "Bundle", "id": "1ebef040-38c6-4263-b8d9-954b86512074", "meta": { "lastUpdated": "2021-06-07T18:05:53.736+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://fhirserver.exafluence.com/STU3/EpisodeOfCare?status=ACTIVE" } ], "entry": [ { "fullUrl": "http://fhirserver.exafluence.com/STU3/EpisodeOfCare/123456", "resource": { "resourceType": "EpisodeOfCare", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T18:04:06.729+00:00", "profile": [ "http://hl7.org/fhir/stu3/episodeofcare.html" ] }, "identifier": [ { "system": "http://example.org/sampleepisodeofcare-identifier", "value": "123" } ], "status": "active", "statusHistory": [ { "status": "planned", "period": { "start": "2014-09-01T00:00:00+00:00", "end": "2014-09-14T00:00:00+00:00" } }, { "status": "active", "period": { "start": "2014-09-15T00:00:00+00:00", "end": "2014-09-21T00:00:00+00:00" } }, { "status": "onhold", "period": { "start": "2014-09-22T00:00:00+00:00", "end": "2014-09-24T00:00:00+00:00" } }, { "status": "active", "period": { "start": "2014-09-25T00:00:00+00:00" } } ], "type": [ { "coding": [ { "system": "http://hl7.org/fhir/episodeofcare-type", "code": "hacc", "display": "Home and Community Care" } ] } ], "diagnosis": [ { "condition": { "reference": "Condition/stroke" }, "role": { "coding": [ { "system": "http://hl7.org/fhir/diagnosis-role", "code": "CC", "display": "Chief complaint" } ] }, "rank": 1 } ], "patient": { "reference": "Patient/example" }, "managingOrganization": { "reference": "Patient/example" }, "period": { "start": "2014-09-01T00:00:00+00:00" }, "referralRequest": [ { "display": "Referral from Example Aged Care Services" } ], "careManager": { "reference": "Practitioner/14", "display": "Amanda Assigned" }, "team": [ { "reference": "CareTeam/example", "display": "example care team" } ], "account": [ { "reference": "Account/example", "display": "example account" } ] } } ] }

ClinicalImpression.Create(STU 3)

Description

EXF-FHIR Clinical Expression resource type gives a record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Organisation

Request
http://127.0.0.1:8183/STU3/ClinicalImpression

Content Type

:

application/json

Example

:-

{ "resourceType": "ClinicalImpression", "id": "example", "text": { "status": "generated" }, "identifier": [ { "value": "12345" } ], "status": "completed", "description": "This 26 yo male patient is brought into ER by ambulance after being involved in a motor vehicle accident", "subject": { "reference": "Patient/example" }, "context": { "reference": "Encounter/example" }, "effectivePeriod": { "start": "2014-12-06T20:00:00+11:00", "end": "2014-12-06T22:33:00+11:00" }, "date": "2014-12-06T22:33:00+11:00", "assessor": { "reference": "Practitioner/example" }, "problem": [ { "display": "MVA" } ], "investigation": [ { "code": { "text": "Initial Examination" }, "item": [ { "display": "deep laceration of the scalp (left temporo-occipital)" }, { "display": "decreased level of consciousness" }, { "display": "disoriented to time and place" }, { "display": "restless" } ] } ], "summary": "provisional diagnoses of laceration of head and traumatic brain injury (TBI)", "finding": [ { "itemCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9", "code": "850.0" } ] } } ] }

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
status string Describes the status
code CodeableConcept Kind of assessment performed
description String Why/how the assessment was performed
subject Reference Patient or group assessed
context Reference Encounter or Episode created from
effective[x] Date/Period Time of assessment
date DateTime When the assessment was documented
assessor Reference The clinician performing the assessment
previous Reference Reference to last assessment
problem Reference Relevant impressions of patient state
investigation Investigation One or more sets of investigations (signs, symptions, etc.)
protocol uri Clinical Protocol followed
summary string Summary of the assessment
finding Finding Possible or likely findings and diagnoses
prognosisCodeableConcept CodeableConcept Estimate of likely outcome
prognosisReference Reference RiskAssessment expressing likely outcome
action Reference Action taken as part of assessment procedure
note Annotation Comments made about the ClinicalImpression

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

ClinicalImpression.Read(STU 3)

Description

EXF-FHIR ClinicalImpression resource enables the user to retrieve the details of a ClinicalImpression.

General Information

HTTP Method

:

GET

Request URL

:

STU3/ClinicalImpression

Request
http://localhost:8183/STU3/ClinicalImpression/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/ClinicalImpression/123456

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
status string Describes the status
code CodeableConcept Kind of assessment performed
description String Why/how the assessment was performed
subject Reference Patient or group assessed
context Reference Encounter or Episode created from
effective[x] Date/Period Time of assessment
date DateTime When the assessment was documented
assessor Reference The clinician performing the assessment
previous Reference Reference to last assessment
problem Reference Relevant impressions of patient state
investigation Investigation One or more sets of investigations (signs, symptions, etc.)
protocol uri Clinical Protocol followed
summary string Summary of the assessment
finding Finding Possible or likely findings and diagnoses
prognosisCodeableConcept CodeableConcept Estimate of likely outcome
prognosisReference Reference RiskAssessment expressing likely outcome
action Reference Action taken as part of assessment procedure
note Annotation Comments made about the ClinicalImpression

Response

{ "resourceType": "ClinicalImpression", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T18:06:39.876+00:00", "profile": [ "http://hl7.org/fhir/stu3/clinicalimpression.html" ] }, "identifier": [ { "value": "12345" } ], "status": "completed", "description": "This 26 yo male patient is brought into ER by ambulance after being involved in a motor vehicle accident", "subject": { "reference": "Patient/example" }, "context": { "reference": "Encounter/example" }, "date": "2014-12-06T11:33:00+00:00", "assessor": { "reference": "Practitioner/example" }, "problem": [ { "display": "MVA" } ], "investigation": [ { "code": { "text": "Initial Examination" }, "item": [ { "display": "deep laceration of the scalp (left temporo-occipital)" }, { "display": "decreased level of consciousness" }, { "display": "disoriented to time and place" }, { "display": "restless" } ] } ], "summary": "provisional diagnoses of laceration of head and traumatic brain injury (TBI)", "finding": [ { "itemCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9", "code": "850.0" } ] } } ] }

ClinicalImpression.Search(STU 3)

Description

EXF-FHIR ClinicalImpression resource enables the user to retrieve the required details of a ClinicalImpression based on the search parameters like identifiers, status etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/ClinicalImpression

Request
http://localhost:8183/STU3/ClinicalImpression?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/ClinicalImpression?status=COMPLETED

Search Parameters

Name Type Expression
action reference ClinicalImpression.action
assessor reference ClinicalImpression.assessor
context reference ClinicalImpression.context
date date ClinicalImpression.date
finding-code Token ClinicalImpression.finding.item.as(CodeableConcept)
Identifier Token Organization.identifier
finding-ref reference ClinicalImpression.finding.item.as(Reference)
investigation reference ClinicalImpression.investigation.item
patient reference ClinicalImpression.subject
previous reference ClinicalImpression.previous
problem reference ClinicalImpression.problem
status token ClinicalImpression.status
subject reference ClinicalImpression.subject

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
status string Describes the status
code CodeableConcept Kind of assessment performed
description String Why/how the assessment was performed
subject Reference Patient or group assessed
context Reference Encounter or Episode created from
effective[x] Date/Period Time of assessment
date DateTime When the assessment was documented
assessor Reference The clinician performing the assessment
previous Reference Reference to last assessment
problem Reference Relevant impressions of patient state
investigation Investigation One or more sets of investigations (signs, symptions, etc.)
protocol uri Clinical Protocol followed
summary string Summary of the assessment
finding Finding Possible or likely findings and diagnoses
prognosisCodeableConcept CodeableConcept Estimate of likely outcome
prognosisReference Reference RiskAssessment expressing likely outcome
action Reference Action taken as part of assessment procedure
note Annotation Comments made about the ClinicalImpression

Response

{ "resourceType": "Bundle", "id": "7591bc5a-005a-4416-83d9-3f642712dae6", "meta": { "lastUpdated": "2021-06-07T18:07:59.832+00:00" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "http://fhirserver.exafluence.com/STU3/ClinicalImpression?status=COMPLETED" } ], "entry": [ { "fullUrl": "http://fhirserver.exafluence.com/STU3/ClinicalImpression/65431c321-sc3d513-as3x513", "resource": { "resourceType": "ClinicalImpression", "id": "65431c321-sc3d513-as3x513", "meta": { "versionId": "1", "lastUpdated": "2021-06-01T09:53:02.207+00:00", "profile": [ "http://hl7.org/fhir/stu3/clinicalimpression.html" ] }, "identifier": [ { "use": "official", "value": "65431c321-sc3d513-as3x513" } ], "status": "completed", "description": "This 26 yo male patient is brought into ER by ambulance after being involved in a motor vehicle accident", "subject": { "reference": "Patient/example" }, "context": { "reference": "Encounter/example" }, "effectiveDateTime": "2014-12-06T22:33:00+11:00" } }, { "fullUrl": "http://fhirserver.exafluence.com/STU3/ClinicalImpression/123456", "resource": { "resourceType": "ClinicalImpression", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T18:06:39.876+00:00", "profile": [ "http://hl7.org/fhir/stu3/clinicalimpression.html" ] }, "identifier": [ { "value": "12345" } ], "status": "completed", "description": "This 26 yo male patient is brought into ER by ambulance after being involved in a motor vehicle accident", "subject": { "reference": "Patient/example" }, "context": { "reference": "Encounter/example" }, "date": "2014-12-06T11:33:00+00:00", "assessor": { "reference": "Practitioner/example" }, "problem": [ { "display": "MVA" } ], "investigation": [ { "code": { "text": "Initial Examination" }, "item": [ { "display": "deep laceration of the scalp (left temporo-occipital)" }, { "display": "decreased level of consciousness" }, { "display": "disoriented to time and place" }, { "display": "restless" } ] } ], "summary": "provisional diagnoses of laceration of head and traumatic brain injury (TBI)", "finding": [ { "itemCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-9", "code": "850.0" } ] } } ] } } ] }

Specimen.Create(STU 3)

Description

EXF-FHIR Specimen resource covers substances used for diagnostic and environmental testing. The focus of the specimen resource is the process for gathering, maintaining and processing the specimen as well as where the specimen originated.

General Information

HTTP Method

:

POST

Request URL

:

STU3/Specimen

Request
http://127.0.0.1:8183/STU3/Specimen

Content Type

:

application/json

Example

:-

{ "resourceType": "Specimen", "id": "101", "text": { "status": "generated" }, "contained": [ { "resourceType": "Substance", "id": "hep", "code": { "coding": [ { "system": "http://hl7.org/fhir/v3/EntityCode", "code": "HEPL" } ] } } ], "identifier": [ { "system": "http://ehr.acme.org/identifiers/collections", "value": "23234352356" } ], "accessionIdentifier": { "system": "http://lab.acme.org/specimens/2011", "value": "X352356" }, "status": "available", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "122555007", "display": "Venous blood specimen" } ] }, "subject": { "reference": "Patient/example", "display": "Peter Patient" }, "receivedTime": "2011-03-04T07:03:00Z", "request": [ { "reference": "ProcedureRequest/example" } ], "collection": { "collector": { "reference": "Practitioner/example" }, "collectedDateTime": "2011-05-30T06:15:00Z", "quantity": { "value": 6, "unit": "mL" }, "method": { "coding": [ { "system": "http://hl7.org/fhir/v2/0488", "code": "LNV" } ] }, "bodySite": { "coding": [ { "system": "http://snomed.info/sct", "code": "49852007", "display": "Structure of median cubital vein (body structure)" } ], "text": "Right median cubital vein" } }, "container": [ { "identifier": [ { "value": "48736-15394-75465" } ], "description": "Green Gel tube", "type": { "text": "Vacutainer" }, "capacity": { "value": 10, "unit": "mL" }, "specimenQuantity": { "value": 6, "unit": "mL" }, "additiveReference": { "reference": "#hep" } } ], "note": [ { "text": "Specimen is grossly lipemic" } ] }

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
accessIdentifier Identifier Identifier assigned by the lab
status string Describes the status
type CodeableConcept Kind of material that forms the specimen
subject Reference Where the specimen came from. This may be from the patient(s) or from the environment or a device
receivedTime DateTime The time when specimen was received for processing
parent Reference Specimen from which this specimen originated
request Reference(Organization) Why the specimen was collected
collection Collection Collection details
processing Processing Processing and processing step details
container Container Direct container of specimen (tube/slide, etc.)
note Annotation Comments

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

Specimen.Read(STU 3)

Description

EXF-FHIR Specimen resource enables the user to retrieve the details of a Specimen.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Specimen

Request
http://localhost:8183/STU3/Specimen/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Specimen/123456

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
accessIdentifier Identifier Identifier assigned by the lab
status string Describes the status
type CodeableConcept Kind of material that forms the specimen
subject Reference Where the specimen came from. This may be from the patient(s) or from the environment or a device
receivedTime DateTime The time when specimen was received for processing
parent Reference Specimen from which this specimen originated
request Reference(Organization) Why the specimen was collected
collection Collection Collection details
processing Processing Processing and processing step details
container Container Direct container of specimen (tube/slide, etc.)
note Annotation Comments

Response

{ "resourceType": "Specimen", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T18:09:08.901+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Specimen" ] }, "identifier": [ { "system": "http://ehr.acme.org/identifiers/collections", "value": "23234352356" }, { "system": "http://lab.acme.org/specimens/2011", "value": "X352356" } ], "status": "available", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "122555007", "display": "Venous blood specimen" } ] }, "subject": { "reference": "Patient/example", "display": "Peter Patient" }, "receivedTime": "2011-03-04T07:03:00+00:00", "request": [ { "reference": "ProcedureRequest/example" } ], "collection": { "collector": { "reference": "Practitioner/example" }, "collectedDateTime": "2011-05-30T06:15:00Z", "quantity": { "value": 6, "unit": "mL" }, "method": { "coding": [ { "system": "http://hl7.org/fhir/v2/0488", "code": "LNV" } ] }, "bodySite": { "coding": [ { "system": "http://snomed.info/sct", "code": "49852007", "display": "Structure of median cubital vein (body structure)" } ], "text": "Right median cubital vein" } }, "container": [ { "identifier": [ { "value": "48736-15394-75465" } ], "description": "Green Gel tube", "type": { "text": "Vacutainer" }, "capacity": { "value": 10, "unit": "mL" }, "specimenQuantity": { "value": 6, "unit": "mL" }, "additiveReference": { "reference": "#hep" } } ], "note": [ { "text": "Specimen is grossly lipemic" } ] }

Specimen.Search(STU 3)

Description

EXF-FHIR Specimen resource enables the user to retrieve the required details of a Specimen based on the search parameters like identifiers, status etc.

General Information

HTTP Method

:

GET

Request URL

:

STU3/Specimen

Request
http://localhost:8183/STU3/Specimen?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/Specimen?status=AVAILABLE

Search Parameters

Name Type Expression
accession Token Specimen.accessionIdentifier
bodysite token Specimen.collection.bodySite
collected date Specimen.collection.collected
collector reference Specimen.collection.collector
container Token Specimen.container.type
Identifier Token Specimen.identifier
container-id token Specimen.container.identifier
parent reference Specimen.parent
patient reference Specimen.subject
status token Specimen.status
subject reference Specimen.subject
type token Specimen.type

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
accessIdentifier Identifier Identifier assigned by the lab
status string Describes the status
type CodeableConcept Kind of material that forms the specimen
subject Reference Where the specimen came from. This may be from the patient(s) or from the environment or a device
receivedTime DateTime The time when specimen was received for processing
parent Reference Specimen from which this specimen originated
request Reference(Organization) Why the specimen was collected
collection Collection Collection details
processing Processing Processing and processing step details
container Container Direct container of specimen (tube/slide, etc.)
note Annotation Comments

Response

{ "resourceType": "Bundle", "id": "e40bbadc-ed5d-4a76-baba-c604dc6213b2", "meta": { "lastUpdated": "2021-06-07T18:10:20.813+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://fhirserver.exafluence.com/STU3/Specimen?status=AVAILABLE" } ], "entry": [ { "fullUrl": "http://fhirserver.exafluence.com/STU3/Specimen/123456", "resource": { "resourceType": "Specimen", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T18:09:08.901+00:00", "profile": [ "https://fhir.hl7.org.uk/STU3/StructureDefinition/Specimen" ] }, "identifier": [ { "system": "http://ehr.acme.org/identifiers/collections", "value": "23234352356" }, { "system": "http://lab.acme.org/specimens/2011", "value": "X352356" } ], "status": "available", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "122555007", "display": "Venous blood specimen" } ] }, "subject": { "reference": "Patient/example", "display": "Peter Patient" }, "receivedTime": "2011-03-04T07:03:00+00:00", "request": [ { "reference": "ProcedureRequest/example" } ], "collection": { "collector": { "reference": "Practitioner/example" }, "collectedDateTime": "2011-05-30T06:15:00Z", "quantity": { "value": 6, "unit": "mL" }, "method": { "coding": [ { "system": "http://hl7.org/fhir/v2/0488", "code": "LNV" } ] }, "bodySite": { "coding": [ { "system": "http://snomed.info/sct", "code": "49852007", "display": "Structure of median cubital vein (body structure)" } ], "text": "Right median cubital vein" } }, "container": [ { "identifier": [ { "value": "48736-15394-75465" } ], "description": "Green Gel tube", "type": { "text": "Vacutainer" }, "capacity": { "value": 10, "unit": "mL" }, "specimenQuantity": { "value": 6, "unit": "mL" }, "additiveReference": { "reference": "#hep" } } ], "note": [ { "text": "Specimen is grossly lipemic" } ] } } ] }

ImagingStudy.Create(STU 3)

Description

EXF-FHIR Imaging Study resource type provides information on a single DICOM imaging study, and the series and imaging objects in that study

General Information

HTTP Method

:

POST

Request URL

:

STU3/ImagingStudy

Request
http://127.0.0.1:8183/STU3/ImagingStudy

Content Type

:

application/json

Example

:-

{ "resourceType": "ImagingStudy", "id": "example", "text": { "status": "generated" }, "uid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045", "patient": { "reference": "Patient/dicom" }, "started": "2011-01-01T11:01:20+03:00", "numberOfSeries": 1, "numberOfInstances": 1, "series": [ { "uid": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630", "number": 3, "modality": { "system": "http://dicom.nema.org/resources/ontology/DCM", "code": "CT" }, "description": "CT Surview 180", "numberOfInstances": 1, "bodySite": { "system": "http://snomed.info/sct", "code": "67734004", "display": "Upper Trunk Structure" }, "instance": [ { "uid": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903", "number": 1, "sopClass": "urn:oid:1.2.840.10008.5.1.4.1.1.2" } ] } ] }

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
uid oid Formal DICOM identifier for the study
accession Identifier Related workflow identifier ("Accession Number")
identifier Identifier Other identifiers for the study
availability String Describes the availability
modalityList Coding All series modality if actual acquisition modalities
patient Reference Who the images are of
context Reference(Organization) Originating context
started DateTime When the study was started
basedOn Reference Request fulfilled
referrer Reference Referring physician
interpreter Reference Who interpreted images
endpoint Reference Study access endpoint
numberOfSeries unsignedint Number of Study Related Series
numberOfInstances unsignedint Number of Study Related Instances
procedureReference Reference The performed Procedure reference
procedureCode CodeableConcept The performed procedure code
reason CodeableConcept Why the study was requested
description string Institution-generated description
series Series Each study has one or more series of instances

Response

HTTP/1.1 201 Created

Cache-Control

:

no-cache

Pragma

:

no-cache

Content-Type

:

application/json; charset=utf-8

ImagingStudy.Read(STU 3)

Description

EXF-FHIR ImagingStudy resource enables the user to retrieve the details of an ImagingStudy.

General Information

HTTP Method

:

GET

Request URL

:

STU3/ImagingStudy

Request
http://localhost:8183/STU3/ImagingStudy/{ID}

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/ImagingStudy/123456

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
uid oid Formal DICOM identifier for the study
accession Identifier Related workflow identifier ("Accession Number")
identifier Identifier Other identifiers for the study
availability String Describes the availability
modalityList Coding All series modality if actual acquisition modalities
patient Reference Who the images are of
context Reference(Organization) Originating context
started DateTime When the study was started
basedOn Reference Request fulfilled
referrer Reference Referring physician
interpreter Reference Who interpreted images
endpoint Reference Study access endpoint
numberOfSeries unsignedint Number of Study Related Series
numberOfInstances unsignedint Number of Study Related Instances
procedureReference Reference The performed Procedure reference
procedureCode CodeableConcept The performed procedure code
reason CodeableConcept Why the study was requested
description string Institution-generated description
series Series Each study has one or more series of instances

Response

{ "resourceType": "ImagingStudy", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T18:22:11.164+00:00", "profile": [ "https://www.hl7.org/fhir/carePlan.html" ] }, "uid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045", "patient": { "reference": "Patient/dicom" }, "started": "2011-01-01T08:01:20+00:00", "numberOfSeries": 1, "numberOfInstances": 1, "series": [ { "uid": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630", "number": 3, "description": "CT Surview 180", "numberOfInstances": 1, "bodySite": { "system": "http://snomed.info/sct", "code": "67734004", "display": "Upper Trunk Structure" }, "instance": [ { "uid": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903", "number": 1, "sopClass": "urn:oid:1.2.840.10008.5.1.4.1.1.2" } ] } ] }

ImagingStudy.Search(STU 3)

Description

EXF-FHIR ImagingStudy resource enables the user to retrieve the required details of an ImagingStudy based on the search parameters like identifiers, series etc,.

General Information

HTTP Method

:

GET

Request URL

:

STU3/ImagingStudy

Request
http://localhost:8183/STU3/ImagingStudy?SearchCriteria

Content Type

:

application/json

Example

:-

http://localhost:8183/STU3/ImagingStudy?series=urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630

Search Parameters

Name Type Expression
accession Token ImagingStudy.accession
basedon reference ImagingStudy.basedOn
bodysite token ImagingStudy.series.bodySite
context reference ImagingStudy.context
dicom-class uri ImagingStudy.series.instance.sopClass
Identifier Token ImagingStudy.identifier
endpoint reference ImagingStudy.endpoint | ImagingStudy.series.endpoint
modality Token ImagingStudy.series.modality
patient reference ImagingStudy.patient
performer reference ImagingStudy.series.performer
reason Token ImagingStudy.reason
series uri ImagingStudy.series.uid
started date ImagingStudy.started
study uri ImagingStudy.uid
uid uri ImagingStudy.series.instance.uid

Structure

Name Type Description
Identifier Identifier Identifies this organization across multiple systems
uid oid Formal DICOM identifier for the study
accession Identifier Related workflow identifier ("Accession Number")
identifier Identifier Other identifiers for the study
availability String Describes the availability
modalityList Coding All series modality if actual acquisition modalities
patient Reference Who the images are of
context Reference(Organization) Originating context
started DateTime When the study was started
basedOn Reference Request fulfilled
referrer Reference Referring physician
interpreter Reference Who interpreted images
endpoint Reference Study access endpoint
numberOfSeries unsignedint Number of Study Related Series
numberOfInstances unsignedint Number of Study Related Instances
procedureReference Reference The performed Procedure reference
procedureCode CodeableConcept The performed procedure code
reason CodeableConcept Why the study was requested
description string Institution-generated description
series Series Each study has one or more series of instances

Response

{ "resourceType": "Bundle", "id": "bf8f1bdc-e074-4072-b159-978ebe9bb2ac", "meta": { "lastUpdated": "2021-06-07T18:24:51.469+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "http://fhirserver.exafluence.com/STU3/ImagingStudy?series=urn%3Aoid%3A2.16.124.113543.6003.2588828330.45298.17418.2723805630" } ], "entry": [ { "fullUrl": "http://fhirserver.exafluence.com/STU3/ImagingStudy/123456", "resource": { "resourceType": "ImagingStudy", "id": "123456", "meta": { "versionId": "1", "lastUpdated": "2021-06-07T18:22:11.164+00:00", "profile": [ "https://www.hl7.org/fhir/carePlan.html" ] }, "uid": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045", "patient": { "reference": "Patient/dicom" }, "started": "2011-01-01T08:01:20+00:00", "numberOfSeries": 1, "numberOfInstances": 1, "series": [ { "uid": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630", "number": 3, "description": "CT Surview 180", "numberOfInstances": 1, "bodySite": { "system": "http://snomed.info/sct", "code": "67734004", "display": "Upper Trunk Structure" }, "instance": [ { "uid": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903", "number": 1, "sopClass": "urn:oid:1.2.840.10008.5.1.4.1.1.2" } ] } ] } } ] }