FHIR

FHIR for Developers - Getting Started

Part 1 - FHIR Version, maturity model, & github

01

This is the main documentation page, https://build.fhir.org/documentation.html

There is also a git hub page, https://github.com/HL7/fhir

02

This tutorial uses version 4.0, go to the folllowing link for Publication (Version) History http://hl7.org/fhir/directory.html

03

You can find the maturity model if you google,

FHIR Maturiy model

go to the https://build.fhir.org/versions.html and click on the The FHIR Maturiy Model link

04

Each Element / Resourse in FHIR has a rating in the spec. Normative means it works in every version leading forward

Part 2 - Navigate the FHIR Home page - "Resources"

01

Go to the fire home page and navigate to the https://build.fhir.org/documentation.html home page.

The https://build.fhir.org/resourcelist.html page contains the documentation for most elements

02

Anything with a capital N is Normative meaning the resource works in the current version, and will work in future versions.

03

Click on any resource for its documentation such as Patient, which is Normative

Part 3 - Resource Documentation

01

On the Patient documentation page https://build.fhir.org/patient.html, there a links in the header. Click on the Patient Administration Work Group link

02

This is the home page of the Owner to the Patient resource. These are people who make decisions on the resource. (Only relative if you want to get envolved)

03

On the Patient page you can see the Patient has been Normative since (v4.0.0)

04

The Compartments: is the bundle that returns Patient, Practitioner, and RelatedPerson.

05

If we click on the Patient link next to Compartments it will take us the Patient resource and show us what is contained within it`

Part 4 - Resource Content

01

Scroll down on the main Patient Resource Page https://build.fhir.org/patient.html, to see the Resource Structure, and in different formats such as XML, JSON, and Turtle

02

The Patient inherits its structure from a resource called DomainResource. We can see the structure of DomainResource by clicking on it

03

Back on the Patient page, the column shows the name of the reosource
Resource, and its fields

04

The thirds column Card, for Cardinality, shows if the field needs a value, and and the last column shows the Description and Contrains and explains what values the field accepts.

1..1 means the field needs a value most fields do not require one

05

0..* means it can nne value or multiple values as strings in an array or list.

For example if you use the link field the 1..1 Cardinality shows you must also use other & type

If you use the communicatin field you must include a vaulue for language

Part 5- Terminology Binding - Resource

01

On the resource page scroll below Resource Content to Terminology Binding, click this link to go straight to it,
https://build.fhir.org/patient.html#:~:text=Terminology%20Bindings

Part 6 - search

01

Scroll down on the same page as Resource Binding and Terminology Binding To the Bottom or click here, https://build.fhir.org to get to the Search Parameters

02

These make it easier to search for fields when combing data among many patients. For Example, the address-citycode search parameter can look inside the address fields of many patients and see if they meet or don't meet a condition.

03

This makes search queries simplier, for example, phone would replace,

Patient.telecom.where(system='phone')

Part 7 - Patient Resource Examples JSON,XML,Turtle

01

See the example of the resource at the top of Patient page and click the examples tab https://build.fhir.org/patient-example.json.html

02

This is the JSON structure of the patient resource https://build.fhir.org/patient-example.json.html

03

The above JSON Example represents the Resource Content on the previous Patient Content Tab

Part 8 - Detailed Descriptions & Mappings (5 ws)

01

The "Detailed Description" tab is self exaplanitory, It explains more about each "Resource" and "Field" if you click on the resource or field in the first column, it will take you inside the the "Detailed Description" tab https://build.fhir.org/patient-definitions.html#Patient

02

The Mappings tab contains the 5 W's Who,What,Where,When,Why,

This is advanced and I don't quite get it

03

The FiveWs is a Resource, click the top link to see its Content Details Below are mappings to the old HL7

I don't quite get it but i'm sure it will be useful

Part 9 Operations & Extensions & R4 Conversions

01

Operations begin with a dollar sign $ I think these are search parameters and functions that are outside of the RESTful Api wihtin FHIR, not sure.

02

Extensions will be explored in future tutorials http://hl7.org/fhir/R5/extensibility.html

09-02b

and extension can be used on pretty much any resource, and the data type of and Extension consist of a pair uri & value

03

R4 Conversions can be find here is needed http://hl7.org/fhir/extensions/conversions-Patient.html

Part -10 - Data Types

01

Click this link to see details on all the different Data type http://hl7.org/fhir/R5/datatypes.html

RESTFul APi

go back and do