Page Comparison

...

Expand

title	2) Endpoint - the URL where the resource is found

The URL defines where the client can access the desired resources - for example the Patient resource.

Code Block
url='http://hapi.fhir.org/baseR4/Patient'

Query String:

For GET requests, the URL may also contain any necessary query parameters like the id of the patient you are searching for. When using net.http.get{}, the parameters argument takes in a table of key-value pairs and automatically formats the query string The ? indicates the end of the url and beginning of the parameters. Key-value pairs are separated by &.

Code Block
http://hapi.fhir.org/baseR4/Patient?id=12324&name=JohnBruce

These URLs can be hardcoded if necessary, or built using various URL Encoding strategies.

Expand

title	3) Header - the metadata providing information about the request

The header includes metadata requirements defined by the API to provide information about the request.

Code Block
headers= { ['Content-Type'] = 'application/fhir+json', ['Authorization'] = 'Bearer '..token }

This can contain information such as:

Connection and content types
Authentication information like credentials, cookies, or an access token
MIME types
Entity tags (ETAGS)

patientid=33751&status=active&firstname=Bruce&lastname=Wayne

Form Data

Expand

title	4) Body - the payload of the request, containing the content to be sent

Some requests require a body where we add the resource content or additional information to be sent to the server. This can be in a few potential formatsThe HTTP formats will typically be specified by the API you’re working with and often requires the appropriate Content-Type header. Common formats include:

JSON

Code Block

language	json

[{
    "patientid": "33751",
    "status": "active",
    "firstname": ”Bruce",
    "lastname": ”Wayne",
	...
}]

See Parsing and Serializing JSON.

XML

Code Block

language	xml

<patient>
  <patientid>33751</patientid>
   <status>active</status>
   <firstname>Bruce</firstname>
   <lastname>Wayne</lastname>
</patient>

See Working with XML

Query String format

The query string can be found in the body or can be included in the URL of the request.

Code Block

language	lua

local formData = {
      ["file"] = "@/path/to/file.txt",
      ["name"] = "Bruce Wayne",
      ["email"] = "bruce.wayne@example.com"
   }

Form data for data sent from a web form. Typically handled in Lua using string or table functions, storing data as name-value pairs.

Versions Compared

Old Version 7

New Version Current

Key