Skip to content

Latest commit

 

History

History
4909 lines (4336 loc) · 93.1 KB

resource-specifications.md

File metadata and controls

4909 lines (4336 loc) · 93.1 KB
id title date version lastAuthor mimeType links source wikigdrive
1pra9Trk_pf9pWs5HVMcFyq8rC3ubybUPZ0_Il2M3uoE
Resource Specifications
2024-02-17T18:48:45.904Z
545
horner
text/x-markdown
0008bcbb1563384efe0a28ada6f97e9432e65f10

Supported Resources

AllergyIntolerance

CarePlan

CareTeam

Condition

Device

DiagnosticReport

DocumentReference

Encounter

Goal

Immunization

Location

Medication

MedicationRequest

Observation

Organization

Patient

Practitioner

PractitionerRole

Procedure

Provenance

AllergyIntolerance

Description

The AllergyIntolerance resource returns data regarding an undesirable, physiological response associated with exposure to a given substance unique to a single patient.

A list of allergies for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 AllergyIntolerance

Data Version: USCDI v1

Supported Profiles: US Core STU3 AllergyIntolerance

Functions

Function HTTP Method URL Template
AllergyIntolerance.READ GET [baseURL]/AllergyIntolerance/{ID}
AllergyIntolerance.SEARCH GET [baseURL]/AllergyIntolerance?_id={ID}

Parameters

Name Description Data Type Required Searchable
id AllergyIntolerance logical FHIR ID String NO Yes
meta Metadata about the AllergyIntolerance Meta No No
clinicalStatus Status of the AllergyIntolerance
  • active
  • resolved
 CodableConcept No No
verificationStatus Certainty of the AllergyIntolerance
  • confirmed
  • entered-in-error
 CodableConcept No No
type Physiological mechanism
  • allergy
  • intolerance
 Code No No
code Code identifying the AllergyIntolerance CodableConcept Yes No
note Comments associated with the AllergyIntolerance Annotation No No
reaction Adverse events linked to exposure to the substance BackboneElement No No
patient Reference to the Patient resource for whom the AllergyIntolerance is recorded Patient Reference Yes Yes
recordedDate First date the AllergyIntolerance was recorded dateTime No No

Supported Searches

Parameter(s) URL Template
id [baseURL]/AllergyIntolerance?_id={ID}
patient [baseURL]/AllergyIntolerance?patient={reference}

Request

{{% pre language="html" theme="RDark" %}}

https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/AllergyIntolerance/11

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}

{
	"resourceType": "AllergyIntolerance",
	"id": "11",
	"meta": {
		"versionId": "0",
		"lastUpdated": "2022-08-05T18:33:45Z",
		"profile": [
			"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
		]
	},
	"clinicalStatus": {
		"coding": [
			{
				"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
				"code": "active"
			}
		]
	},
	"verificationStatus": {
		"coding": [
			{
				"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
				"code": "confirmed"
			}
		]
	},
	"type": "allergy",
	"code": {
		"coding": [
			{
				"system": "http://snomed.info/sct",
				"code": "387235007",
				"display": "Penicillamine"
			}
		],
		"text": "PENICILLAMINE"
	},
	"reaction": [
		{
			"manifestation": [
				{
					"coding": [
						{
							"system": "http://snomed.info/sct",
							"code": "247472004",
							"display": "Hives"
						}
					],
					"text": "Hives"
				}
			]
		}
	],
	"patient": {
		"reference": "Patient/18"
	},
	"recordedDate": "2022-08-05T18:33:45Z"
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

CarePlan

Description

The CarePlan resource returns data related to the intention of how one or more practitioners deliver care for a unique patient or group of patients during a period of time. CarePlans may or may not be related to a specific condition or set of conditions.

A list of care plans for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 Careplan

Data Version: USCDI v1

Supported Profiles: US Core STU3 CarePlan

Functions

Function HTTP Method URL Template
CarePlan.READ GET [baseURL]/CarePlan/{ID}
CarePlan.SEARCH GET [baseURL]/CarePlan?_id={ID}

Parameters

Name Description Data Type Required Searchable
id CarePlan FHIR logical ID String No Yes
subject Reference to the Patient resource for whom the CarePlan is recorded Patient Reference Yes Yes
category Type of CarePlan
  • assess-plan
 Slice Yes Yes
intent Level of authority of the CarePlan
  • order
 Code Yes No
text Human-readable summary of the CarePlan Narrative Yes No
status Indication of when the CarePlan is/was actionable
  • draft
  • active
  • completed
  • entered-in-error
 Code Yes =o

Supported Searches

Parameter(s) URL Template
id [baseURL]/CarePlan?_id={ID}
patient+category [baseURL]/CarePlan?patient={reference}&category=assess-plan

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/CarePlan/11

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "CarePlan",
	"id": "11",
	"subject": {
		"reference": "Patient/18",
		"type": "Patient",
		"display": "William S. Hart"
	},
	"category": [
		{
			"coding": [
				{
					"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
					"code": "assess-plan"
				}
			],
			"text": "AssessPlan"
		}
	],
	"intent": "order",
	"text": {
		"status": "additional",
		"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">No narrative provided for encounter 11</div>"
	},
	"status": "completed"
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

CareTeam

Description

The CareTeam resource returns data regarding everyone involved in the care of a unique patient. This team may consist of medical practitioners, friends, relatives, and organizations.

A list of care teams for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 CareTeam

Data Version: USCDI v1

Supported Profiles: US Core STU3 CareTeam

Functions

Function HTTP Method URL Template
CareTeam.READ GET [baseURL]/CareTeam/{ID}
CareTeam.SEARCH GET [baseURL]/CareTeam?_id={ID}

Parameters

Name Description Data Type Required Searchable
id CareTeam logical FHIR ID String No Yes
subject Reference to the Patient resource for whom the CareTeam is recorded Patient Reference Yes Yes
meta Metadata about the CareTeam Meta No No
status Current state of the CareTeam
  • active
 Code No Yes
period Effective dates of the CareTeam Period No No
participant References to the people and organizations involved in the CareTeam BackboneElement Yes No

Supported Searches

Parameter(s) URL Template
_id [baseURL]/CareTeam?_id={ID}
patient+status [baseURL]/CareTeam?patient={reference}&status=active

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/CareTeam/18

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "CareTeam",
	"id": "18",
	"subject": {
		"reference": "Patient/18",
		"type": "Patient",
		"display": "John M. Sample, M.D."
	},
	"status": "active",
	"period": {
		"start": "2012-06-23"
	},
	"participant": [
		{
			"role": [
				{
					"coding": [
						{
							"system": "http://snomed.info/sct",
							"code": "59058001",
							"display": "Family Medicine"
						}
					]
				}
			],
			"member": {
				"reference": "Practitioner/88",
				"display": "John M. Sample, M.D."
			},
			"period": {
				"start": "2010-03-23"
			}
		},
		{
			"role": [
				{
					"coding": [
						{
							"system": "http://snomed.info/sct",
							"code": "67822003",
							"display": "Child"
						}
					]
				}
			],
			"member": {
				"reference": "Patient/27",
				"display": "William S. Hart"
			},
			"period": {
				"start": "2010-03-23"
			}
		}
	]
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Condition

Description

The Condition resource returns data regarding a clinical condition, problem, or diagnosis that has risen to clinical significance for a unique patient.

A list of conditions for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 Condition

Data Version: USCDI v1

Supported Profiles: US Core STU3 Condition

Functions

Function HTTP Method URL Template
Condition.READ GET [baseURL]/Condition/{ID}
Condition.SEARCH GET [baseURL]/Condition?patient={reference}

Parameters

Name Description Data Type Required Searchable
id Condition logical FHIR ID String No Yes
meta Metadata about the Condition Meta No No
clinicalStatus Clinical status of the Condition
  • active
  • recurrence
  • relapse
  • inactive
  • remission
  • resolved
 CodeableConcept No Yes
verificationStatus Information to support the clinical status
  • unconfirmed
  • provisional
  • differential
  • confirmed
  • refuted
  • entered-in-error
 CodeableConcept No No
category Category of the Condition
  • problem-list-item
  • health-concern
 CodeableConcept Yes Yes
code ICD9, ICD10, or SNOMED concept ID identifying the Condition CodeableConcept Yes Yes
subject Reference to the Patient resource with the Condition Patient Reference Yes Yes
encounter Encounter during which the Condition was recorded Encounter Reference No No
onsetDateTime Estimated or actual date the Condition began dateTime No Yes
recordedDate Date the Condition was first recorded in the system dateTime No No

Supported Searches

Parameter(s) URL Template
_id [baseURL]/Condition?_id={ID}
patient [baseURL]/Condition?patient={reference}
onset-date [baseURL]/Condition?onset-date={prefix}{date}
category [baseURL]/Condition?category={token}
clinical-status [baseURL]/Condition?clinical-status={token}
code [baseURL]/Condition?code={token}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Condition/26

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Condition",
	"id": "26",
	"meta": {
		"versionId": "7",
		"lastUpdated": "2022-08-05T18:33:45Z",
		"profile": [
			"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
		]
	},
	"clinicalStatus": {
		"coding": [
			{
				"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
				"code": "active"
			}
		]
	},
	"verificationStatus": {
		"coding": [
			{
				"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
				"code": "confirmed"
			}
		]
	},
	"category": [
		{
			"coding": [
				{
					"system": "http://terminology.hl7.org/CodeSystem/condition-category",
					"code": "problem-list-item",
					"display": "Problem List Item"
				}
			]
		}
	],
	"code": {
		"coding": [
			{
				"system": "http://snomed.info/sct",
				"code": "49436004",
				"display": "Atrial fibrillation (disorder)"
			},
			{
				"system": "http://hl7.org/fhir/sid/icd-10",
				"code": "I48.91",
				"display": "Unspecified atrial fibrillation"
			},
			{
				"system": "http://hl7.org/fhir/sid/icd-9",
				"code": "427.31",
				"display": "Atrial Fibrillation"
			}
		],
		"text": "Atrial fibrillation"
	},
	"subject": {
		"reference": "Patient/18"
	},
	"recordedDate": "2010-03-23T15:33:55Z"
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Device

Description

The Device resource returns data regarding a medical or non-medical manufactured item that is used in but unchanged by the provision of healthcare.

A list of Devices for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 Device

Data Version: USCDI v1

Supported Profiles: US Core STU3 Implantable Device

Functions

Function HTTP Method URL Template
Device.READ GET [baseURL]/Device/{ID}
Device.SEARCH GET [baseURL]/Device?patient={reference}

Parameters

Name Description Data Type Required Searchable
id Device logical FHIR ID String No Yes
udiCarrier Unique Device Identifier (UDI) Barcode BackboneElement No No
status Device availability
  • active
  • inactive
  • entered-in-error
  • unknown
 Code No No
distinctIdentifier Distinct identification required for cell or tissue based products String No No
manufactureDate Date the Device was made dateTime No No
expirationDate Date the Device expires dateTime No No
lotNumber Manufacturing lot number String No No
serialNumber Serial number assigned by the manufacturer String No No
deviceName Name assigned by the manufacturer BackboneElement No No
type Kind of type of Device CodeableConcept Yes No
patient Reference to the Patient resource to whom the Device is affixed Patient Reference Yes Yes
note Notes and comments regarding the Device Annotation No No

Supported Searches

Parameter(s) URL Template
_id [baseURL]/Device?_id={ID}
patient [baseURL]/Device?patient={reference}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Device/662

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Device",
	"id": "662",
	"udiCarrier": [
		{
			"deviceIdentifier": "09504000059118",
			"carrierHRF": "(01)09504000059118(17)141120(10)7654321D(21)"
		}
	],
	"status": "active",
	"distinctIdentifier": "ABCDE12345",
	"expirationDate": "2014-11-20",
	"lotNumber": "7654321D",
	"serialNumber": "10987654d321",
	"deviceName": [
		{
			"name": "Coated femoral stem prosthesis, modular",
			"type": "user-friendly-name"
		}
	],
	"type": {
		"coding": [
			{
				"system": "http://snomed.info/sct",
				"code": "468063009",
				"display": "Coated femoral stem prosthesis, modular"
			}
		],
		"text": "Knee joint prosthesis"
	},
	"patient": {
		"reference": "Patient/18"
	},
	"note": [
		{
			"text": "https://accessgudid.nlm.nih.gov/devices/09504000059118"
		}
	]
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

DiagnosticReport

Description

The DiagnosticReport resource returns data regarding the findings and interpretations of diagnostic tests.

A list of DiagnosticReports for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 DiagnosticReport

Data Version: USCDI v1

Supported Profiles: US Core STU3 DiagnosticReport Profile for Laboratory Results Reporting, US Core STU3 DiagnosticReport Profile for Report and Note exchange

Functions

Function HTTP Method URL Template
DiagnosticReport.READ GET [baseURL]/DiagnosticReport/{ID}
DiagnosticReport.SEARCH GET [baseURL]/DiagnosticReport?patient={reference}

Parameters

Name Description Data Type Required Searchable
id DiagnosticReport logical FHIR ID String No Yes
identifier Business identifier assigned to the DiagnosticReport by the performer or system Identifier No No
status Status of the DiagnosticReport
  • registered
  • partial
  • preliminary
  • final
 Code Yes No
category Clinical discipline, department, or diagnostic service that created the DiagnosticReport Slice Yes Yes
code Test, panel, or battery that was ordered CodeableConcept Yes Yes
subject Reference to the Patient resource who is the subject of the DiagnosticReport Patient Reference Yes Yes
encounter Healthcare event where the test was ordered Encounter Reference No No
effectiveDateTime Specimen collection date or period dateTime Yes No
performer Reference to the resource who performed the diagnostic service Practitioner or Organization Reference No No
resultsInterpreter Reference to the resource that interpreted the diagnostic results Practitioner or Organization Reference No No
result Reference to the Observation resources Observation Reference No No
presentedForm Entire report as reported Attachment No No

Supported Searches

Parameter(s) URL Template
_id [baseURL]/Resource?_id={ID}
patient [baseURL]/Resource?patient={reference}
patient+code [baseURL]/Resource?patient={reference}&code={token}
patient+category [baseURL]/Resource?patient={reference}&category={token}
patient+category+date [baseURL]/Resource?patient={reference}&category={token}&date={date}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/DiagnosticReport/91

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "DiagnosticReport",
	"id": "91",
	"identifier": [
		{
			"use": "usual",
			"value": "91"
		}
	],
	"status": "unknown",
	"category": [
		{
			"coding": [
				{
					"system": "http://loinc.org",
					"display": "Radiology",
					"code": "LP29684-5"
				}
			]
		}
	],
	"code": {
		"coding": [
			{
				"system": "http://loinc.org",
				"code": "30746-2",
				"display": "Portable XR Chest Views"
			}
		]
	},
	"subject": {
		"reference": "Patient/18"
	},
	"effectiveDateTime": "2009-08-20",
	"issued": "2009-08-20T20:25:02Z",
	"performer": [
		{
			"reference": "Organization/41"
		}
	],
	"resultsInterpreter": [
		{
			"reference": "Practitioner/8"
		}
	],
	"presentedForm": [
		{
			"contentType": "application/txt",
			"data": "RGlhZ25vc3RpYyBJbWFnaW5nIFJlcG9ydA0KDQpFeGFtaW5hdGlvbjogIFJBRCAtIENoZXN0IEZy\nb250YWwgYW5kIExhdGVyYWwgMiBWaWV3cy4NCkRhdGUgb2YgRXhhbTogICBBdWcgMjAsIDIwMDkg\nNDowNDowMCBQTS4NCkNvbXBhcmlzb246ICBOb25lLg0KUmVsZXZhbnQgQ2xpbmljYWwgSW5mb3Jt\nYXRpb246ICAgIGNoZiwgc29iIHdpdGggZXhlcnRpb24sIGFvcnRpYw0KcmVndXJnaXRhdGlvbi4N\nCk51bWJlciBvZiBJbWFnZXM6IDINCg0KRGlzY3Vzc2lvbjogICBNaWxkIGludGVyc3RpdGlhbCBw\ncm9taW5lbmNlIG5vdGVkIG1heSByZXByZXNlbnQNCmludGVyc3RpdGlhbCBwdWxtb25hcnkgZWRl\nbWEuIFRoZXJlIGlzIHNvbWUgaGlsYXIgdmFzY3VsYXIgY29uZ2VzdGlvbg0KYWxzby4gTm8gcGxl\ndXJhbCBlZmZ1c2lvbi4gTWlsZCBjYXJkaW9tZWdhbHkuIEVjdGF0aWMgYW5kIHRvcnR1b3VzDQpk\nZXNjZW5kaW5nIHRob3JhY2ljIGFvcnRhIG5vdGVkLiBMZWZ0IHN1YmNsYXZpYW4gYXBwcm9hY2gg\nZHVhbC1sZWFkDQpwYWNlci4NCg0KSW1wcmVzc2lvbjogICBNaWxkIGludGVyc3RpdGlhbCBwdWxt\nb25hcnkgZWRlbWEuDQoNClN0ZXZlIEEgU21pdGgsIE1EDQoNClRyYW5zY3JpcHRpb24gSUQ6ICBQ\nT1dFUlNDUklCRQ0KRDogMDgvMjAvMjAwOSAxNjoyMToyNQ0KDQpKb2IgSUQ6ICAxMjM0NTYNCg0K\nICAgT1JERVJJTkc6ICBTYW1wbGUsIE1pY2hhZWwgTUQNCiAgIFBBVElFTlQ6ICBIYXJ0LCBXaWxs\naWFtIFMuDQogICBNUk46IDEwMDE5DQogICBET0I6IDExLzMwLzE5MTUNCiAgIFZJU0lUL0FETUlU\nIERBVEU6IDA4LzIwLzIwMDkNCiAgIEVYQU0gREFURTogMDgvMjAvMjAwOQ0KICAgTE9DQVRJT046\nICBEaWFnbm9zdGljIFJhZGlvbG9neQ0KICAgUEFUSUVOVCBUWVBFOiAgTw0KUkFEIC0gQ2hlc3Qg\nLSAyIFZpZXdzIC0gRnJvbnRhbC9MYXRlcmFs"
		}
	]
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

DocumentReference

Description

The DocumentReference resource returns data for any document created for any purpose.

A list of documents for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 DocumentReference

Data Version: USCDI v1

Supported Profiles: US Core STU3 DocumentReference

Functions

Function HTTP Method URL Template
DocumentReference.READ GET [baseURL]/DocumentReference/{ID}
DocumentReference.SEARCH GET [baseURL]/DocumentReference?_id={ID}

Parameters

Name Description Data Type Required Searchable
id DocumentReference logical FHIR ID String No Yes
identifier Additional DocumentReference identifiers Identifier No No
status Status of the DocumentReference
  • current
  • entered-in-error
 Code Yes No
type Kind of DocumentReference CodeableConcept Yes Yes
category Clinical Note CodeableConcept Yes Yes
subject Reference to the Patient resource to whom the DocumentReference pertains Patient Reference Yes No
date Date the document was created Instant No Yes
author Reference to the Practitioner resource that created the DocumentReference Practitioner Reference No No
custodian Reference to the Organization resource that maintains the DocumentReference Organization Reference No No
content The document BackboneElement Yes No
context Clinical context of the DocumentReference including an Encounter reference and date BackboneElement No No

Supported Searches

Parameter(s) URL Template
_id [baseURL]/DocumentReference?_id={ID}
patient [baseURL]/DocumentReference?patient={reference}
patient+type [baseURL]/DocumentReference?patient={reference}&type={token}
patient+category [baseURL]/DocumentReference?patient={reference}&category={token}
patient+category+date [baseURL]/DocumentReference?patient={reference}&category={token}&date={date}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/DocumentReference/91

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "DocumentReference",
	"id": "91",
	"identifier": [
		{
			"system": "urn:oid:1.2.840.114398.1.660376160187469368594400296994359.999.5",
			"value": "91"
		}
	],
	"status": "current",
	"type": {
		"coding": [
			{
				"system": "http://loinc.org",
				"code": "30746-2",
				"display": "Portable XR Chest Views"
			}
		],
		"text": "Portable XR Chest Views"
	},
	"category": [
		{
			"coding": [
				{
					"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
					"code": "clinical-note",
					"display": "Clinical Note"
				}
			],
			"text": "Clinical Note"
		}
	],
	"subject": {
		"reference": "Patient/18"
	},
	"date": "2009-08-20T04:00:00Z",
	"author": [
		{
			"reference": "Practitioner/55",
			"display": "Selenium Selenium"
		}
	],
	"custodian": {
		"reference": "Organization/43"
	},
	"content": [
		{
			"attachment": {
				"contentType": "text/plain",
				"data": "RGlhZ25vc3RpYyBJbWFnaW5nIFJlcG9ydA0KDQpFeGFtaW5hdGlvbjogIFJBRCAtIENoZXN0IEZy\nb250YWwgYW5kIExhdGVyYWwgMiBWaWV3cy4NCkRhdGUgb2YgRXhhbTogICBBdWcgMjAsIDIwMDkg\nNDowNDowMCBQTS4NCkNvbXBhcmlzb246ICBOb25lLg0KUmVsZXZhbnQgQ2xpbmljYWwgSW5mb3Jt\nYXRpb246ICAgIGNoZiwgc29iIHdpdGggZXhlcnRpb24sIGFvcnRpYw0KcmVndXJnaXRhdGlvbi4N\nCk51bWJlciBvZiBJbWFnZXM6IDINCg0KRGlzY3Vzc2lvbjogICBNaWxkIGludGVyc3RpdGlhbCBw\ncm9taW5lbmNlIG5vdGVkIG1heSByZXByZXNlbnQNCmludGVyc3RpdGlhbCBwdWxtb25hcnkgZWRl\nbWEuIFRoZXJlIGlzIHNvbWUgaGlsYXIgdmFzY3VsYXIgY29uZ2VzdGlvbg0KYWxzby4gTm8gcGxl\ndXJhbCBlZmZ1c2lvbi4gTWlsZCBjYXJkaW9tZWdhbHkuIEVjdGF0aWMgYW5kIHRvcnR1b3VzDQpk\nZXNjZW5kaW5nIHRob3JhY2ljIGFvcnRhIG5vdGVkLiBMZWZ0IHN1YmNsYXZpYW4gYXBwcm9hY2gg\nZHVhbC1sZWFkDQpwYWNlci4NCg0KSW1wcmVzc2lvbjogICBNaWxkIGludGVyc3RpdGlhbCBwdWxt\nb25hcnkgZWRlbWEuDQoNClN0ZXZlIEEgU21pdGgsIE1EDQoNClRyYW5zY3JpcHRpb24gSUQ6ICBQ\nT1dFUlNDUklCRQ0KRDogMDgvMjAvMjAwOSAxNjoyMToyNQ0KDQpKb2IgSUQ6ICAxMjM0NTYNCg0K\nICAgT1JERVJJTkc6ICBTYW1wbGUsIE1pY2hhZWwgTUQNCiAgIFBBVElFTlQ6ICBIYXJ0LCBXaWxs\naWFtIFMuDQogICBNUk46IDEwMDE5DQogICBET0I6IDExLzMwLzE5MTUNCiAgIFZJU0lUL0FETUlU\nIERBVEU6IDA4LzIwLzIwMDkNCiAgIEVYQU0gREFURTogMDgvMjAvMjAwOQ0KICAgTE9DQVRJT046\nICBEaWFnbm9zdGljIFJhZGlvbG9neQ0KICAgUEFUSUVOVCBUWVBFOiAgTw0KUkFEIC0gQ2hlc3Qg\nLSAyIFZpZXdzIC0gRnJvbnRhbC9MYXRlcmFs"
			},
			"format": {
				"system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
				"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
				"display": "mimeType Sufficient"
			}
		}
	]
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Encounter

Description

The Encounter resource returns data regarding a clinical interaction between a patient and one or more healthcare providers.

A list of encounters for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 Encounter

Data Version: USCDI v1

Supported Profiles: US Core STU3 Encounter

Functions

Function HTTP Method URL Template
Encounter.READ GET [baseURL]/Encounter/{ID}
Encounter.SEARCH GET [baseURL]/Encounter?_id={ID}

Parameters

Name Description Data Type Required Searchable
id Encounter logical FHIR ID String No Yes
meta Metadata about the Encounter Meta No No
identifier Additional identifiers for the Encounter Identifier No No
status Status of the Encounter
  • in-progress
  • finished
 Code Yes Yes
class Classification of the Encounter setting
  • ambulatory
 Coding Yes No
type Type of Encounter CodeableConcept Yes No
subject Reference to the Patient resource present at the Encounter Patient Reference Yes Yes
location List of References to Location resources where the Patient was during the Encounter Backbone Element No No
period Start and end times of the Encounter Period No Yes
reasonCode Coded reason the Encounter is taking place CodeableConcept No No
participant List of References to Practitioner resources that were involved in the Encounter BackboneElement No No
hospitalization Details about admission to a healthcare service BackboneElement No No

Supported Searches

Parameter(s) URL Template
_id [baseURL]/Encounter?_id={ID}
patient [baseURL]/Encounter?patient={reference}
patient+date [baseURL]/Encounter?patient={reference}&date={date}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Encounter/63

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Encounter",
	"id": "63",
	"meta": {
		"profile": [
			"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
		]
	},
	"identifier": [
		{
			"use": "usual",
			"system": "urn:oid:1.2.840.114398.1.660376160187469368594400296994359.999.7",
			"value": "63"
		}
	],
	"status": "finished",
	"class": {
		"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
		"code": "AMB",
		"display": "ambulatory"
	},
	"type": [
		{
			"text": "Visit"
		}
	],
	"subject": {
		"reference": "Patient/18"
	},
	"location": [
		{
			"location": {
				"reference": "Location/41"
			}
		}
	],
	"period": {
		"end": "2022-08-05T18:33:50Z",
		"start": "2014-09-10T13:52:21Z"
	},
	"reasonCode": [
		{
			"coding": [
				{
					"system": "http://snomed.info/sct",
					"code": "69466000",
					"display": "Unknown procedure"
				}
			],
			"text": "Unknown procedure"
		}
	],
	"participant": [
		{
			"type": [
				{
					"coding": [
						{
							"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
							"code": "PPRF",
							"display": "primary performer"
						}
					],
					"text": "Primary performer"
				}
			],
			"period": {
				"end": "2022-08-05T18:33:50Z",
				"start": "2014-09-10T13:52:21Z"
			},
			"individual": {
				"reference": "Practitioner/55"
			}
		}
	],
	"hospitalization": {
		"dischargeDisposition": {
			"coding": [
				{
					"system": "http://www.nubc.org/patient-discharge",
					"code": "01",
					"display": "Discharged to Home"
				}
			],
			"text": "Discharged to Home"
		}
	}
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Goal

Description

The Goal resource returns data describing one or more, short or long term healthcare objectives for a unique patient.

A list of goals for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 Goal

Data Version: USCDI v1

Supported Profiles: US Core STU3 Goal

Functions

Function HTTP Method URL Template
Goal.READ GET [baseURL]/Goal/{ID}
Goal.SEARCH GET [baseURL]/Goal?patient={reference}

Parameters

Name Description Data Type Required Searchable
id Goal logical FHIR ID String No Yes
meta Metadata about the Goal Meta No No
lifecycleStatus State of the Goal
  • active
  • on-hold
  • accepted
 Code Yes No
description Human readable or coded description of the desired outcome of care CodeableConcept Yes No
subject Reference to the Patient resource for whom the goal is established Patient Reference Yes Yes
target Indication of what should be done by when BackboneElement No No

Supported Searches

Parameter(s) URL Template
_id [baseURL]/Goal?_id={ID}
patient [baseURL]/Goal?patient={reference}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Goal/1

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Goal",
	"id": "1",
	"meta": {
		"profile": [
			"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
		]
	},
	"lifecycleStatus": "accepted",
	"description": {
		"text": "Blood Pressure:120/80",
		"coding": [
			{
				"system": "http://loinc.org",
				"code": "18684-1"
			}
		]
	},
	"subject": {
		"reference": "Patient/18",
		"display": "Hart, William S."
	},
	"target": [
		{
			"dueDate": "2022-07-29"
		}
	]
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Immunization

Description

The Immunization resource returns data describing the event of a vaccine administration or a reported record of immunization for a unique patient.

A list of immunizations for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 Immunization

Data Version: USCDI v1

Supported Profiles: US Core STU3 Immunization

Functions

Function HTTP Method URL Template
Immunization.READ GET [baseURL]/Immunization/{ID}
Immunization.SEARCH GET [baseURL]/Immunization?patient={reference}

Parameters

Name Description Data Type Required Searchable
id Immunization logical FHIR ID String No Yes
meta Metadata about the Immunization Meta No No
vaccineCode The vaccine that was administered CodeableConcept Yes No
lotNumber Lot number of the vaccine product String No No
expirationDate Date the vaccine batch expires Date No No
doseQuantity Quantity of vaccine that was administered SimpleQuantity No No
status Current status of the Immunization event
  • Completed
  • entered-in-error
  • not-done
 Code Yes Yes
statusReason Reason a vaccine was not-done CodeableConcept No No
patient Reference to the Patient resource to whom the vaccine was administered Patient Reference Yes Yes
recorded Date the Immunization was first recorded in the chart dateTime No No
occurrenceDateTime Date the vaccine was administered dateTime Yes No
primarySource Indication of if the content of the Immunization record was reported by the person who administered the vaccine Boolean Yes No

Supported Searches

Parameter(s) URL Template
_id [baseURL]/Immunization?_id={ID}
patient [baseURL]/Immunization?patient={reference}
status [baseURL]/Immunization?status={token}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Immunization/9

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Immunization",
	"id": "9",
	"meta": {
		"profile": [
			"http://hl7.org/fhir/StructureDefinition/Immunization"
		]
	},
	"vaccineCode": {
		"coding": [
			{
				"system": "http://hl7.org/fhir/sid/cvx",
				"code": "09"
			}
		]
	},
	"lotNumber": "4598",
	"expirationDate": "1999-06-01",
	"status": "completed",
	"patient": {
		"reference": "Patient/18"
	},
	"recorded": "2010-03-23T16:09:10Z",
	"occurrenceDateTime": "1999-04-28T17:07:00Z",
	"primarySource": true
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Location

Description

The Location resource returns data for a physical place where services are provided or where resources and participants may be found.

A list of locations can be returned when searching by name or address.

Standards

FHIR Version: R4 Location

Data Version: USCDI v1

Supported Profiles: US Core STU3 Location

Functions

Function HTTP Method URL Template
Location.READ GET [baseURL]/Location/{ID}
Location.SEARCH GET [baseURL]/Location?name={token}

Parameters

Name Description Data Type Required Searchable
id Location logical FHIR ID String No No
status General availability of the Location
  • active
  • inactive
 Code No No
name Non-unique human-given name String Yes Yes
telecom Contact details of communication devices at the Location ContactPoint No No
address Physical place Address No Yes
managingOrganization Reference to the Organization resource responsible for provisioning the Location Organization Reference No No

Supported Searches

Parameter(s) URL Template
name [baseURL]/Location?name={token}
address [baseURL]/Location?address={token}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Location/41

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


	"resourceType": "Location",
	"id": "41",
	"status": "active",
	"name": "Better Corp",
	"telecom": [
		{
			"system": "phone",
			"value": "6504596270"
		}
	],
	"address": {
		"line": [
			"1700 Amphitheatre Parkway"
		],
		"city": "Mountain View",
		"state": "CA",
		"postalCode": "94043",
		"country": "US"
	}
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Medication

Description

The Medication resource returns data used for the identification and definition of a medication. This resource can be used as reference in a MedicationRequest resource to define the medication being prescribed to a unique patient.

Standards

FHIR Version: R4 Medication

Data Version: USCDI v1

Supported Profiles: US Core STU3 Medication

Functions

Function HTTP Method URL Template
Medication.READ GET [baseURL]/Medication/{ID}

Parameters

Name Description Data Type Required Searchable
id Medication logical FHIR ID String No No
code RxNorm code that specifies the Medication CodeableConcept Yes No

Supported Searches

Parameter(s) URL Template

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Medication/670934

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Medication",
	"id": "670934",
	"code": {
		"coding": [
			{
				"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
				"code": "966247",
				"display": "SYNTHROID 50 MCG Oral Tablet"
			}
		],
		"text": "Levothyroxine Sodium 0.05 MG Oral Tablet [Synthroid]"
	}
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

MedicationRequest

Description

The MedicationRequest resource returns data regarding an order or request for the supply of medication and instructions for its administration.

A list of MedicationRequests for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 MedicationRequest

Data Version: USCDI v1

Supported Profiles: US Core STU3 MedicationRequest

Functions

Function HTTP Method URL Template
MedicationRequest.READ GET [baseURL]/MedicationRequest/{ID}
MedicationRequest.SEARCH GET [baseURL]/MedicationRequest?patient={reference}

Parameters

Name Description Data Type Required Searchable
id MedicationRequest logical FHIR ID String No Yes
status State of the order
  • active
  • stopped
  • entered-in-error
 Code Yes Yes
intent Type of order
  • order
 Code Yes Yes
contained Inline Resources Resource No No
medicationReference Reference to the Medication resource being administered Medication Reference Yes No
medicationCodeableConcept Code identifying the the requested medication Codeable Concept Yes No
reportedBoolean Indicates if the record was captured by another source Boolean No No
subject Reference to the Patient resource to whom the medication will be given Patient Reference Yes Yes
authoredOn Date the MedicationRequestwas initially made dateTime Yes Yes
requester Reference to the Practitioner or Organization resource that made the request Practitioner or OrganizationReference Yes No
encounter Reference to the Encounter resource during which the request was made Encounter Reference No No
dosageInstruction How the medication should be taken Dosage No No

Supported Searches

Parameter(s) URL Template
patient [baseURL]/MedicationRequest?patient={reference}
patient+intent [baseURL]/MedicationRequest?patient={reference}&intent=order
patient+intent+status [baseURL]/MedicationRequest?patient={reference}&intent=order&status={token}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/MedicationRequest/23

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "MedicationRequest",
	"id": "23",
	"status": "stopped",
	"intent": "order",
	"contained": [
		{
			"resourceType": "Medication",
			"id": "289532",
			"code": {
				"coding": [
					{
						"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
						"code": "284215",
						"display": "clindamycin HCl 300 MG Oral Capsule"
					}
				],
				"text": "Clindamycin 300 MG Oral Capsule"
			}
		}
	],
	"medicationReference": {
		"reference": "#289532",
		"display": "clindamycin HCl 300 MG Oral Capsule"
	},
	"reportedBoolean": false,
	"subject": {
		"reference": "Patient/18",
		"display": "William Hart",
		"type": "Patient"
	},
	"authoredOn": "2004-03-15",
	"requester": {
		"reference": "Practitioner/55",
		"display": "Selenium Selenium",
		"type": "Practitioner"
	},
	"dosageInstruction": [
		{
			"text": "1 capsules prn"
		}
	]
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Observation

Description

The Observation resource returns measurements and simple assertions made about a unique patient, device, or subject.

A list of Observations for a specific patient can be returned when searching by that patient.

Standards

FHIR Version: R4 Observation

Data Version: USCDI v1

Supported Profiles: US Core STU3 Laboratory Result Observation, US Core STU3 Pediatric BMI for Age Observation, US Core STU3 Pediatric Head Occipital-frontal Circumference Percentile Observation, US Core STU3 Pediatric Weight for Height Observation Observation, US Core STU3 Pulse Oximetry Observation, US Core STU3 Smoking Status Observation

Functions

Function HTTP Method URL Template
Observation.READ GET [baseURL]/Observation/{ID}
Observation.SEARCH GET [baseURL]/Observation?patient={reference}

Parameters

Name Description Data Type Required Searchable
id Observation logical FHIR ID String No No
meta Metadata about the Observation Metadata No No
code Test or measurement name CodeableConcept Yes Yes
category Classification of the Observation Slice Yes Yes
referenceRange Guide for interpretation of the result BackboneElement No No
subject Reference to the Patient Resource who the observation is about Patient Reference Yes Yes
effectiveDateTime Clinically relevant date for the Observation dateTime No Yes
issued Date and time the Observation was made available Instant No No
interpretation Indication of "normalcy" of the result CodeableConcept No No
valueQuantity Result and units for the test or measurement Quantity No No
status Status of the result value
  • final
  • entered-in-error
 Code Yes No
component Used when reporting multi-part Observations Slice No No
note Comments about the Observation Annotation No No

Supported Searches

Parameter(s) URL Template
patient [baseURL]/Observation?patient={reference}
patient+code [baseURL]/Observation?patient={reference}&code={token}
patient+category [baseURL]/Observation?patient={reference}&category={token}
patient+category+date [baseURL]/Observation?patient={reference}&category={token}&date={date}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Observation/175

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Observation",
	"id": "179",
	"meta": {
		"profile": [
			"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
		]
	},
	"code": {
		"coding": [
			{
				"system": "http://loinc.org",
				"code": "29463-7",
				"display": "BODY WEIGHT"
			}
		],
		"text": "BODY WEIGHT"
	},
	"category": [
		{
			"coding": [
				{
					"system": "http://terminology.hl7.org/CodeSystem/observation-category",
					"code": "vital-signs",
					"display": "Vital Signs"
				}
			],
			"text": "Vital Signs"
		},
		{
			"coding": [
				{
					"system": "http://terminology.hl7.org/CodeSystem/observation-category",
					"code": "laboratory",
					"display": "Laboratory"
				}
			],
			"text": "Laboratory"
		}
	],
	"subject": {
		"reference": "Patient/18",
		"display": "William Hart"
	},
	"effectiveDateTime": "2009-07-06T19:11:00Z",
	"issued": "2009-07-06T19:11:00Z",
	"interpretation": [
		{
			"coding": [
				{
					"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
					"code": "N",
					"display": "Normal"
				}
			],
			"text": "Normal"
		}
	],
	"valueQuantity": {
		"value": 180,
		"unit": "[lb_av]",
		"system": "http://unitsofmeasure.org",
		"code": "[lb_av]"
	},
	"status": "final"
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Organization

Description

The Organization resource returns data regarding a recognized group formed for the purpose of achieving a collective action, such as companies, institutions, departments, healthcare practices, and payers.

A list of Organizations can be returned when searching by name or address.

Standards

FHIR Version: R4 Organization

Data Version: USCDI v1

Supported Profiles: US Core STU3 Organization

Functions

Function HTTP Method URL Template
Organization.READ GET [baseURL]/Organization/{ID}
Organization.SEARCH GET [baseURL]/Organization?name={token}

Parameters

Name Description Data Type Required Searchable
id Organization logical FHIR ID String No No
identifier NPI for the Organization Slice No Yes
active Whether the Organization is still in active use Boolean Yes No
name Name associated with the Organization String Yes Yes
telcom Contact details for the Organization ContactPoint No No
address Physical location of the Organization Address No Yes
partOf Reference to an Organization resource to which the Organization belongs Organization Reference No No

Supported Searches

Parameter(s) URL Template
name [baseURL]/Organization?name={token}
address [baseURL]/Organization?address={token}
npi [baseURL]/Organization?npi={token}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Organization/41

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Organization",
	"id": "41",
	"identifier": [
		{
			"system": "http://hl7.org/fhir/sid/us-npi",
			"value": "1111111112"
		}
	],
	"active": true,
	"name": "Better Corp",
	"telecom": [
		{
			"system": "phone",
			"value": "6504596270"
		}
	],
	"address": [
		{
			"line": [
				"1700 Amphitheatre Parkway"
			],
			"city": "Mountain View",
			"state": "CA",
			"postalCode": "94043",
			"country": "US"
		}
	]
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Patient

Description

The Patient resource returns demographic and other administrative information about an individual receiving health-related services.

A list of patients can be returned when searching by demographic information.

Standards

FHIR Version: R4 Patient

Data Version: USCDI v1

Supported Profiles: US Core STU3 Patient

Functions

Function HTTP Method URL Template
Patient.READ GET [baseURL]/Patient/{ID}
Patient.SEARCH GET [baseURL]/Patient?_id={ID}

Parameters

Name Description Data Type Required Searchable
id Patient logical FHIR ID String No Yes
identifier Additional business identifier for the Patient Identifier Yes Yes
name Name associated with the Patient HumanName Yes Yes
telcom Contact details for the Patient ContactPoint No No
address Address for the Patient Address No No
gender Administrative gender
  • male
  • female
  • unknown
  • other
 Code Yes Yes
birthDate Date of birth Date No Yes
deceasedDateTime Death date of the Patient dateTime No No
deceasedBoolean Indicator if the Patient is deceased Boolean No No
maritalStatus Most recent civil marital status CodeableConcept No No
extension Race, ethnicity, and/or birth sex of the Patient Complex No No
communication Preferred language to be used when communicating with the Patient BackboneElement No No
generalPractitioner Reference to the Practitioner or Organization resource acting as the primary care provider Practitioner or Organization Reference No No

Supported Searches

Parameter(s) URL Template
_id [baseURL]/Patient?_id={ID}
identifier [baseURL]/Patient?identifier={token}
name [baseURL]/Patient?name={token}
name+birthdate [baseURL]/Patient?name={token}&birthdate={date}
name+gender [baseURL]/Patient?name={token}&gender={token}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Patient/18

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Patient",
	"id": "18",
	"identifier": [
		{
			"use": "usual",
			"type": {
				"coding": [
					{
						"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
						"code": "MR"
					}
				],
				"text": "MR"
			},
			"system": "urn:oid:1.2.840.114398.1.660376160187469368594400296994359.1.2",
			"value": "10019"
		}
	],
	"name": [
		{
			"use": "official",
			"family": "Hart",
			"given": [
				"William",
				"S."
			]
		}
	],
	"telecom": [
		{
			"system": "phone",
			"value": "2604440099",
			"use": "home"
		},
		{
			"system": "phone",
			"value": "2604370001",
			"use": "mobile"
		},
		{
			"system": "email",
			"value": "[email protected]"
		}
	],
	"address": [
		{
			"use": "home",
			"line": [
				"2300 Commonwealth Avenue"
			],
			"city": "Fort Wayne",
			"district": "Allen",
			"state": "IN",
			"postalCode": "46804",
			"country": "US",
			"period": {
				"start": "2022-08-05"
			}
		},
		{
			"use": "work",
			"district": "Allen",
			"state": "IN",
			"country": "US",
			"period": {
				"start": "2022-08-05"
			}
		}
	],
	"gender": "male",
	"birthDate": "1954-11-30",
	"deceasedBoolean": false,
	"maritalStatus": {
		"coding": [
			{
				"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
				"code": "M"
			}
		]
	},
	"extension": [
		{
			"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
			"extension": [
				{
					"url": "ombCategory",
					"valueCoding": {
						"system": "urn:oid:2.16.840.1.113883.6.238",
						"code": "2028-9",
						"display": "Asian"
					}
				},
				{
					"url": "ombCategory",
					"valueCoding": {
						"system": "urn:oid:2.16.840.1.113883.6.238",
						"code": "2106-3",
						"display": "White"
					}
				},
				{
					"url": "text",
					"valueString": "mixed"
				}
			]
		},
		{
			"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
			"extension": [
				{
					"url": "ombCategory",
					"valueCoding": {
						"system": "urn:oid:2.16.840.1.113883.6.238",
						"code": "2186-5",
						"display": "Not Hispanic or Latino"
					}
				},
				{
					"url": "text",
					"valueString": "Not Hispanic or Latino"
				}
			]
		},
		{
			"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
			"valueCode": "M"
		},
		{
			"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
			"valueCodeableConcept": {
				"coding": [
					{
						"system": "urn:oid:2.16.840.1.113762.1.4.1021.32",
						"code": "",
						"display": "Identifies as Female"
					}
				]
			}
		}
	],
	"communication": [
		{
			"language": {
				"coding": [
					{
						"system": "urn:ietf:bcp:47",
						"code": "en",
						"display": "English"
					}
				],
				"text": "English"
			}
		}
	],
	"generalPractitioner": [
		{
			"reference": "Practitioner/9"
		}
	],
	"active": true
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Practitioner

Description

The Practitioner resource returns data regarding a person who is direct or indirectly involved in the provisioning of healthcare.

A list of Practitioners can be returned when searching by name or identifier.

Standards

FHIR Version: R4 Practitioner

Data Version: USCDI v1

Supported Profiles: US Core STU3 Practitioner

Functions

Function HTTP Method URL Template
Practitioner.READ GET [baseURL]/Practitioner/{ID}
Practitioner.SEARCH GET [baseURL]/Practitioner?name={token}

Parameters

Name Description Data Type Required Searchable
id Practitioner logical FHIR ID String No Yes
identifier NPI Identifier Yes Yes
name Name associated with the Practitioner HumanName Yes Yes
telcom Contact details for the Practitioner ContactPoint No No
address Address for the Practitioner Address No No
gender Administrative gender
  • male
  • female
  • unknown
  • other
 Code No Yes
communication Languages the Practitioner can use in patient communication CodeableConcept No No
active Indicator of if the Practitioner is in active use Boolean No No

Supported Searches

Parameter(s) URL Template
name [baseURL]/Practitioner?name={token}
identifier [baseURL]/Practitioner?identifier={token}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Practitioner/88

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Practitioner",
	"id": "88",
	"identifier": [
		{
			"use": "usual",
			"system": "urn:oid:1.2.840.114398.1.660376160187469368594400296994359.999.31",
			"value": "88"
		}
	],
	"name": [
		{
			"use": "official",
			"family": "Sample",
			"given": [
				"John",
				"M."
			]
		}
	],
	"telecom": [
		{
			"system": "phone",
			"value": "2604596270",
			"use": "work"
		},
		{
			"system": "fax",
			"value": "2604596271"
		},
		{
			"system": "email",
			"value": "[email protected]"
		}
	],
	"address": [
		{
			"use": "home",
			"country": "US",
			"period": {
				"start": "2022-08-05"
			}
		},
		{
			"use": "work",
			"line": [
				"6302 Constitution Drive"
			],
			"city": "Fort Wayne",
			"state": "IN",
			"postalCode": "46804",
			"country": "US",
			"period": {
				"start": "2022-08-05"
			}
		}
	],
	"gender": "unknown",
	"active": true
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

PractitionerRole

Description

The PractitionerRole resource returns data regarding a set of roles, locations, specialties, and/or services that a practitioner may perform at a designated organization.

Standards

FHIR Version: R4 PractitionerRole

Data Version: USCDI v1

Supported Profiles: US Core STU3 PractitionerRole

Functions

Function HTTP Method URL Template
PractitionerRole.READ GET [baseURL]/PractitionerRole/{ID}

Parameters

Name Description Data Type Required Searchable
id PractitionerRole logical FHIR ID String No No
practitioner Reference to the Practitioner resource that is able to provide the defined services for the Organization Practitioner Reference Yes No
organization Reference to the Organization resource where roles are available Organization Reference Yes No
code Roles this practitioner may perform CodeableConcept No No
specialty Specific specialty of the practitioner CodeableConcept No No
location Reference to the Location reference where the practitioner provides care Location Reference No No
telecom Contact details specific to the role/location/service ContactPoint Yes No
endpoint Reference to the Endpoint resources describing the technical endpoints providing access to services Endpoint Reference No No

Supported Searches

Parameter(s) URL Template

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/PractitionerRole/1

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "PractitionerRole",
	"id": "1",
	"active": true,
	"practitioner": {
		"reference": "Practitioner/88",
		"display": "John M. Sample"
	},
	"code": [
		{
			"coding": [
				{
					"system": "urn:oid:1.2.840.114350.1.13.861.1.7.10.836982.1040",
					"code": "1",
					"display": "Physician"
				}
			],
			"text": "Physician"
		}
	],
	"specialty": [
		{
			"coding": [
				{
					"system": "urn:oid:1.2.840.114350.1.72.1.7.7.10.688867.4160",
					"code": "19",
					"display": "Family Practice"
				}
			],
			"text": "Family Practice"
		}
	]
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Procedure

Description

The Procedure resource returns data regarding a physical or non-physical action that was performed on or for a patient.

A list of procedures can be returned for a specific patient when searching by that patient.

Standards

FHIR Version: R4 Procedure

Data Version: USCDI v1

Supported Profiles: US Core STU3 Procedure

Functions

Function HTTP Method URL Template
Procedure.READ GET [baseURL]/Procedure/{ID}
Procedure.SEARCH GET [baseURL]/Procedure?patient={reference}

Parameters

Name Description Data Type Required Searchable
id Provider logical FHIR ID String No Yes
status State of the Procedure
  • completed
  • entered
 Code Yes No
code Identification of the specific Procedure performed CodeableConcept Yes No
subject Reference to the Patient resource who the Procedure was performed on Patient Reference Yes Yes
performedDateTime Date the Procedure was performed dateTime Yes Yes

Supported Searches

Parameter(s) URL Template
_id [baseURL]/Procedure?_id={ID}
patient [baseURL]/Procedure?patient={reference}
patient+date [baseURL]/Procedure?patient={reference}&date={date}

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Procedure/77

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Procedure",
	"id": "77",
	"status": "completed",
	"code": {
		"coding": [
			{
				"system": "http://snomed.info/sct",
				"code": "408754009"
			}
		],
		"text": "CT scan of head"
	},
	"subject": {
		"reference": "Patient/18"
	},
	"performedDateTime": "2013-01-03"
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022

Provenance

Description

The Provenance resource contains information for assessing authenticity, enabling trust, and allowing reproducibility by describing the entities and processes involved in producing, delivering, or influencing another resource.

Standards

FHIR Version: R4 Provenance

Data Version: USCDI v1

Supported Profiles: US Core STU3 Provenance

Functions

Function HTTP Method URL Template
Provenance.READ GET [baseURL]/Provenance?_id={ID}
Provenance.SEARCH GET [baseURL]/[Resource]?_id={ID}&_revinclude=Provenance:target

Parameters

Name Description Data Type Required Searchable
id Provenance logical FHIR ID String No Yes
target Reference to the Resource the Provenance record supports Reference Yes No
recorded Timestamp when the Resource was recorded Instant Yes No
agent Actor involved in recording the Resource Slice Yes No

Supported Searches

Parameter(s) URL Template

Request

{{% pre language="html" theme="RDark" %}}


https://webchartnow.com/fhirr4sandbox/webchart.cgi/fhir/Provenance/Patient-18

{{% /pre %}}

Response

{{% pre language="json" theme="RDark" %}}


{
	"resourceType": "Provenance",
	"id": "Patient-18",
	"target": [
		{
			"reference": "Patient/18"
		}
	],
	"recorded": "2022-08-05T18:33:42Z",
	"agent": [
		{
			"type": {
				"coding": [
					{
						"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
						"code": "author",
						"display": "Author"
					}
				]
			},
			"who": {
				"reference": "Organization/41"
			},
			"onBehalfOf": {
				"reference": "Organization/41"
			}
		}
	]
}

{{% /pre %}}

Error Handling

HTTP Code Severity Description Example
401 Error Unauthorized Permission Denied
403 Error Forbidden Access Denied
404 Error Website Not Found Unsupported Search Path
Permission Denied
500 Error Internal Server Error Out of Memory

Product Information

Product: WebChart EHR

Version: 8.4

Release Date: September 1, 2022