HL7 FHIR DevDays - Home - FHIR · HL7 FHIR DevDays Program, speakers and registration: Save the date. Validate a resource

HL7 and FHIR are the registered trademarks of HL7 International.

HL7 FHIR DevDays Program, speakers and registration: www.fhirdevdays.com

Save the date

http://hl7.org/fhir/2018Jan/operationslist.html

Validate a resource[base]/[Resource]/$validate[base]/[Resource]/[id]/$validate

Terminology operations[base]/ValueSet/[id]/$expand[base]/ValueSet/[id]/$validate-code[base]/CodeSystem/$lookup[base]/CodeSystem/[id]/$subsumes[base]/CodeSystem/[id]/$compose

Fetch records[base]/Patient/[id]/$everything

CDS Hooks[base]/$cds-hook

Meta Operations[base]/$meta [base]/[Resource]/$meta [base]/[Resource]/[id]/$meta[base]/[Resource]/[id]/$meta-add[base]/[Resource]/[id]/$meta-delete

Generate a Document[base]/Composition/[id]/$document

Process Message[base]/$process-message

Find a functional List

ConceptMap operations[base]/ConceptMap/$translate[base]/ConceptMap/[id]/$translate

Closure Table Maintenance[base]/$closure

Questionnaire operations[base]/Questionnaire/$populatehtml [base]/Questionnaire/[id]$populatehtml

$questionnaire

Bundle Operations

Domain Resource Meta

Interactions

Search

Instance

Conditional Interactions

READ GET [base]/[type]/[id]VREAD GET [base]/[type]/[id]/_history/[vid]UPDATE PUT [base]/[type]/[id]DELETE DELETE [base]/[type]/[id]HISTORY GET [base]/[type]/[id]/_history

CREATE POST [base]/[type]SEARCH GET [base]/[type]?[parameters]HISTORY GET [base]/[type]/_history

CAPABILITY GET [base]/metadata BATCH TRANSACTION POST [base]/HISTORY GET [base]/_historySEARCH GET [base]?[parameters]

R4

Parameter TypesBase search URL base-url / resource ? parameter & parameter & .. https://vonk.fire.ly/Patient?name=Johnnumber (: )=(comparator)numberlength=27 date (: ) = comparator yyyy-mm-ddThh:nn:ss(TZ)birthdate=1964-12-10string (: ) = text name=Johnname:exact=John-William token = system | code gender=femalegender=http://hl7.org/fhir/v3/AdministrativeGender|femalegender=|femaleReference (: ) = idsubject:Patient=23Quantity = (comparator) number | system | code value=5.4|http://unitsofmeasure.org|mgvalue=lt5.4|http://unitsofmeasure.org|mgComposite = value , value

= state$value,state$valuestate-on-date=new$2013-05-04,active$2013-05-05 uri (: = uriuri:below=http://acme.org/fhir/

Parameters for all resources_id _id=23_lastUpdated _lastUpdated=gt2010-10-01_tag _tag=http://acme.org/codes|needs-review

_security _security = http://hl7.org/fhir/v3/ActCode|CEL_text _text=(bone OR liver) and metastases_content _content=(bone OR liver) and metastases_list _list=42_has _has:Observation:patient:code=1234-5_type _type=Observation,Condition_query _query=name&parameters

Search result parameters _include _include=MedicationPrescription:patient_revinclude _revinclude=Provenance:target_count _count=50_sort _sort=status,-date,category_summary _summary=true | text | data | count | false_elements _contained _contained = true | false | both_containedType _containedType = container | contained

Chained parametersGET [base-url]/DiagnosticReport?subject.name=peter

CREATE POST If-None-Exist: [search parameters]No matches: Create1 match: 200 OKMulti matches: 412 Precondition Failed

UPDATE PUT [base-url] /[type]/?[search parameters]No matches: Create1 match: UpdateMulti matches: 412 Precondition Failed

DELETE DELETE [base-url] /[type]/?[search parameters] No matched: Delete1 match: DeleteMulti matches: 412 Precondition Failed

Whole System

Type level

[parameter]=100 equal 100 in range [99.5..100.5][parameter]=100.00 equal 100 in range [99.995..100.005[parameter]=lt100 less than 100[parameter]=le100 less or equal to 100[parameter]=gt100 greater than 100[parameter]=ge100 greater or equal to 100[parameter]=ne100 not equal to 100

Comparators for Search

SNOMED CThttp://snomed.info/sctLOINChttp://loinc.orgUCUMhttp://unitsofmeasure.org

Version 2 table codehttp://hl7.org/fhir/v2/[x]Version 3 code systemhttp://hl7.org/fhir/v3/[x]URIurn:ietf:rfc:3986

Terminology Systems

For more see:

Resource

fire.ly

http://hl7.org/fhir/2018Jan/operationslist.html

Validate a resource[base]/[Resource]/$validate[base]/[Resource]/[id]/$validate

Terminology operations[base]/ValueSet/[id]/$expand[base]/ValueSet/[id]/$validate-code[base]/CodeSystem/$lookup[base]/CodeSystem/[id]/$subsumes[base]/CodeSystem/[id]/$compose

Fetch records[base]/Patient/[id]/$everything

CDS Hooks[base]/$cds-hook

Meta Operations[base]/$meta [base]/[Resource]/$meta [base]/[Resource]/[id]/$meta[base]/[Resource]/[id]/$meta-add[base]/[Resource]/[id]/$meta-delete

Generate a Document[base]/Composition/[id]/$document

Process Message[base]/$process-message

Find a functional List

ConceptMap operations[base]/ConceptMap/$translate[base]/ConceptMap/[id]/$translate

Closure Table Maintenance[base]/$closure

Questionnaire operations[base]/Questionnaire/$populatehtml [base]/Questionnaire/[id]$populatehtml

$questionnaire

Bundle Operations

Domain Resource Meta

Interactions

Search

Instance

Conditional Interactions

READ GET [base]/[type]/[id]VREAD GET [base]/[type]/[id]/_history/[vid]UPDATE PUT [base]/[type]/[id]DELETE DELETE [base]/[type]/[id]HISTORY GET [base]/[type]/[id]/_history

CREATE POST [base]/[type]SEARCH GET [base]/[type]?[parameters]HISTORY GET [base]/[type]/_history

CAPABILITY GET [base]/metadata BATCH TRANSACTION POST [base]/HISTORY GET [base]/_historySEARCH GET [base]?[parameters]

R4

Parameter TypesBase search URL base-url / resource ? parameter & parameter & .. https://vonk.fire.ly/Patient?name=Johnnumber (: )=(comparator)numberlength=27 date (: ) = comparator yyyy-mm-ddThh:nn:ss(TZ)birthdate=1964-12-10string (: ) = text name=Johnname:exact=John-William token = system | code gender=femalegender=http://hl7.org/fhir/v3/AdministrativeGender|femalegender=|femaleReference (: ) = idsubject:Patient=23Quantity = (comparator) number | system | code value=5.4|http://unitsofmeasure.org|mgvalue=lt5.4|http://unitsofmeasure.org|mgComposite = value , value

= state$value,state$valuestate-on-date=new$2013-05-04,active$2013-05-05 uri (: = uriuri:below=http://acme.org/fhir/

Parameters for all resources_id _id=23_lastUpdated _lastUpdated=gt2010-10-01_tag _tag=http://acme.org/codes|needs-review

_security _security = http://hl7.org/fhir/v3/ActCode|CEL_text _text=(bone OR liver) and metastases_content _content=(bone OR liver) and metastases_list _list=42_has _has:Observation:patient:code=1234-5_type _type=Observation,Condition_query _query=name&parameters

Search result parameters _include _include=MedicationPrescription:patient_revinclude _revinclude=Provenance:target_count _count=50_sort _sort=status,-date,category_summary _summary=true | text | data | count | false_elements _contained _contained = true | false | both_containedType _containedType = container | contained

Chained parametersGET [base-url]/DiagnosticReport?subject.name=peter

CREATE POST If-None-Exist: [search parameters]No matches: Create1 match: 200 OKMulti matches: 412 Precondition Failed

UPDATE PUT [base-url] /[type]/?[search parameters]No matches: Create1 match: UpdateMulti matches: 412 Precondition Failed

DELETE DELETE [base-url] /[type]/?[search parameters] No matched: Delete1 match: DeleteMulti matches: 412 Precondition Failed

Whole System

Type level

[parameter]=100 equal 100 in range [99.5..100.5][parameter]=100.00 equal 100 in range [99.995..100.005[parameter]=lt100 less than 100[parameter]=le100 less or equal to 100[parameter]=gt100 greater than 100[parameter]=ge100 greater or equal to 100[parameter]=ne100 not equal to 100

Comparators for Search

SNOMED CThttp://snomed.info/sctLOINChttp://loinc.orgUCUMhttp://unitsofmeasure.org

Version 2 table codehttp://hl7.org/fhir/v2/[x]Version 3 code systemhttp://hl7.org/fhir/v3/[x]URIurn:ietf:rfc:3986

Terminology Systems

For more see:

Resource