Kodjin FHIR Server API

Create FHIR Resource Get FHIR Resource Search FHIR Resource by _id Update FHIR Resource FHIRPath Patch Delete FHIR Resource

FHIR Resources-General resources

Organization Get Organization by id Endpoint Endpoint Copy Practitioner Location Medication Device Post EnrollmentResponse

FHIR Resources-Patient Compartment

Patient with fixed Organization Coverage Account AuditEvent Appointment AppointmentResponse AllergyIntolerance Condition Claim Care Team Claim Response Observation(Quantity)Encounter DiagnosticReport Create composition ImagingStudy Immunization EnrollmentResponse MedicationRequest MedicationStatement MedicationAdministration MedicationDispense Procedure DocumentReference ServiceRequest SupplyRequest Provenance RiskAssessment ExplanationOfBenefit Group Device

Conditional Create\Update\Delete

Upsert Conditional Update Search Conditional Delete Search Conditional Post

vread _history by id with _at _history search with _since param _history by resource type with _at param

Search-Global search parameters

Search-Modifiers-:missing

:missing for string :missing for quanity

Search-Modifiers-:text

:text for Codeable Concept :text for Identifier :text for Coding

Search-Modifiers-:exact

:exact for string Address :exact for string

Search-Modifiers-:contains

:contains for Address :contains for string

Search-Modifiers

Search-Search parameters by types-date

date on date date on dateTime date on Instant date on Period date on Timimg

Search-Search parameters by types-token

token on Coding token on CodeableConcept token on string

Search-Search parameters by types-reference

reference [url]

Search-Search parameters by types

number string join composite quantity uri(unsupported)special(unsupported)

Search-Prefixes-gt

gt with date gt with number gt with Instant gt date on Period

Search-Prefixes-ge

ge with date ge with number ge with Instant ge date on Period

Search-Prefixes-le

le with date le with number le with Instant le date on Period

Search-Prefixes-sa

sa with date sa with number sa with Instant sa date on Period

Search-Prefixes-eb

eb with date eb with number eb with Instant eb date on Period

Search-Prefixes-ap

ap with date ap with dateTime ap with Instant ap date on Period

Search-Prefixes-lt

lt with date lt with dateTime lt with Instant lt date on Period

Search-Pagination

cursor pagination

Create Location with position get location by near

_include Get resource _pretty search by POST

Operations-$everything

end & start $everything by patient id

Operations-$summary-Patient Summary

IPS Medication IPS Organization IPS Practitioner IPS Patient IPS MedicationRequest IPS MedicationStatement FHIR MedicationAdministration FHIR MedicationDispense IPS Allergyintolerance IPS Condition Past Problem IPS Procedure IPS Immunization IPS Device IPS DeviceUseStatement IPS Observation Pregnancy: outcome IPS DiagnosticReport Laboratory Results FHIR ClinicalImpression FHIR CarePlan FHIR Consent

Operations-$summary

$validate with profile in url $validate with Parameters $validate Parameters in create mode $snapshot $document via GET $document via POST Get generated document bundle $apply-fhirpath $versions

Create Subscription email Get Subscription list Get Subscription by id Post Observation (trigger subscription)

Bulk Export-Patient Level Export

Kick Off request with all parameters Kick Off request POST with all parameters

Bulk Export-System Level Export

Kick Off with type, since, elements Kick Off request POST with all parameters

Bulk Export-Group Level Export

Kick Off request with all parameters Kick Off request POST with all parameters Create group with subgroup Kick off request with no filters

Get job Delete export

Bulk import from file Get job

Сonverter-xml to json

Сonverter-json to xml

Get TerminologyCapabilities Get CapabilityStatement $subset for CapabilityStatement

Organization with extension Patient with extension

StructureDefinitions

Put SD Post SD with profile discriminator on element Search SD by url Get SD by ID Update SD Delete SD Post SearchParameter Get SearchParameter Get SearchParameter _history Update SearchParameter Delete SearchParameter

Post CodeSystem Get CodeSystem Get CodeSystem by url _summary Put CodeSystem Delete CodeSystem Post ValueSet with filter Get ValueSet Get ValueSet by url Put ValueSet Delete ValueSet Post ConceptMap Get ConceptMap Post NamingSystem Get NamingSystem by id Put NamingSystem Delete NamingSystem

Terminology Operations-ValueSet

$validate-code on ValueSet $validate-code on ValueSet by ID $validate-code on ValueSet using Parameters $validate-code on ValueSet using Parameters and ID $expand with filter parameter $expand by url $expand POST $validate ValueSet

Terminology Operations-CodeSystem

$validate-code on CodeSystem by ID $validate-code on CodeSystem $validate-code on CodeSystem using Parameters $validate-code on CodeSystem using Parameters and ID $lookup $lookup via POST $validate CodeSystem $find-matches $find-matches By ID $subsumes Parameters Coding $subsumes Parameters by ID $subsumes $subsumes with ID

Terminology Operations-ConceptMap

$translate $translate with ID $translate POST by ID $translate POST $validate ConceptMap

POST new template $convert-data HL7 v2 ADT_A01

Patient Observation Filter Observations

Transaction with terminology operations post Bundle Get job by id

KodjinResourceTool

Patient _revinclude

Organization Endpoint with Organization PractitionerRole Location Patient Medication Account AdverseEvent AllergyIntolerance Appointment AppointmentResponse AuditEvent Basic BodyStructure CarePlan CareTeam ChargeItem Coverage Claim ClaimResponse ClinicalImpression Communication CommunicationRequest Composition Condition Consent Contract CoverageEligibilityRequest CoverageEligibilityResponse DetectedIssue Device DeviceRequest DeviceUseStatement DocumentReference DocumentManifest Encounter EnrollmentRequest EpisodeOfCare ExplanationOfBenefit FamilyMemberHistory Flag Goal Group GuidanceResponse ImagingStudy Immunization ImmunizationEvaluation ImmunizationRecommendation Invoice List Measure MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement MolecularSequence NutritionOrder Observation DiagnosticReport Person Procedure Provenance QuestionnaireResponse RelatedPerson RequestGroup ResearchStudy ResearchSubject RiskAssessment Schedule ServiceRequest Specimen SupplyRequest SupplyDelivery Task VisionPrescription Patient _revinclude

Practitioner _revinclude

Organization Location Patient Practitioner Medication Copy Account AdverseEvent AllergyIntolerance Appointment AppointmentResponse AuditEvent Basic CarePlan CareTeam ChargeItem Coverage Copy Claim ClaimResponse ClinicalImpression Communication CommunicationRequest Composition Condition Consent Contract CoverageEligibilityRequest CoverageEligibilityResponse Copy DetectedIssue DocumentReference DocumentManifest Encounter EpisodeOfCare Flag Group ImagingStudy Immunization Invoice Linkage List Measure MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement NutritionOrder Observation Device Copy DeviceRequest DiagnosticReport ExplanationOfBenefit MessageHeader PaymentReconciliation PaymentNotice Person PractitionerRole Procedure Provenance QuestionnaireResponse RequestGroup ResearchStudy RiskAssessment Schedule ServiceRequest Specimen SupplyRequest SupplyDelivery Task VisionPrescription Practitioner _revinclude

PractitionerRole _revinclude

Organization Location Patient Practitioner PractitionerRole Medication Copy Account AdverseEvent AllergyIntolerance Appointment AppointmentResponse AuditEvent Basic CarePlan CareTeam ChargeItem Coverage Copy Claim ClaimResponse ClinicalImpression Communication CommunicationRequest Composition Condition Consent Contract CoverageEligibilityRequest CoverageEligibilityResponse Copy DetectedIssue Device Copy DeviceRequest Encounter DiagnosticReport DocumentReference DocumentManifest ExplanationOfBenefit Flag Group ImagingStudy Immunization Invoice Linkage List Measure MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement MessageHeader NutritionOrder Observation PaymentReconciliation PaymentNotice Procedure Provenance QuestionnaireResponse RequestGroup ResearchStudy RiskAssessment Schedule ServiceRequest Specimen SupplyRequest SupplyDelivery Task VisionPrescription PractitionerRole _revinclude

RelatedPerson _revinclude

Organization Patient RelatedPerson AdverseEvent AllergyIntolerance Appointment AppointmentResponse AuditEvent Basic CarePlan CareTeam ChargeItem Claim Communication CommunicationRequest Composition Condition Consent Contract Coverage Device DeviceRequest DocumentReference DocumentManifest Encounter ExplanationOfBenefit Group ImagingStudy Invoice MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement Observation Person Procedure Provenance QuestionnaireResponse RequestGroup Schedule ServiceRequest SupplyRequest Task RelatedPerson

Person _revinclude

Group _revinclude

Group AdverseEvent CarePlan CareTeam ChargeItem ClinicalImpression Communication CommunicationRequest Condition Consent DeviceRequest DeviceUseStatement DiagnosticReport DocumentReference DocumentManifest Encounter Flag Goal GuidanceResponse ImagingStudy Invoice List MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement Observation Procedure RequestGroup RiskAssessment ServiceRequest Specimen Group

Organization _revinclude

Organization Account Organization _revinclude

AllergyIntolerance _include

Organization PractitionerRole Practitioner Patient Encounter AllergyIntolerance AllergyIntolerance

Condition _include

Organization Patient Encounter Practitioner PractitionerRole RelatedPerson AdverseEvent Condition Copy Condition

Observation _include

Organization Location Practitioner Patient CarePlan Device Encounter DeviceRequest Immunization ImmunizationRecommendation DocumentReference Account QuestionnaireResponse Specimen Observation Observation _include

Kodjin FHIR Server API

Create FHIR Resource Get FHIR Resource Search FHIR Resource by _id Update FHIR Resource FHIRPath Patch Delete FHIR Resource

FHIR Resources-General resources

Organization Get Organization by id Endpoint Endpoint Copy Practitioner Location Medication Device Post EnrollmentResponse

FHIR Resources-Patient Compartment

Patient with fixed Organization Coverage Account AuditEvent Appointment AppointmentResponse AllergyIntolerance Condition Claim Care Team Claim Response Observation(Quantity)Encounter DiagnosticReport Create composition ImagingStudy Immunization EnrollmentResponse MedicationRequest MedicationStatement MedicationAdministration MedicationDispense Procedure DocumentReference ServiceRequest SupplyRequest Provenance RiskAssessment ExplanationOfBenefit Group Device

Conditional Create\Update\Delete

Upsert Conditional Update Search Conditional Delete Search Conditional Post

vread _history by id with _at _history search with _since param _history by resource type with _at param

Search-Global search parameters

Search-Modifiers-:missing

:missing for string :missing for quanity

Search-Modifiers-:text

:text for Codeable Concept :text for Identifier :text for Coding

Search-Modifiers-:exact

:exact for string Address :exact for string

Search-Modifiers-:contains

:contains for Address :contains for string

Search-Modifiers

Search-Search parameters by types-date

date on date date on dateTime date on Instant date on Period date on Timimg

Search-Search parameters by types-token

token on Coding token on CodeableConcept token on string

Search-Search parameters by types-reference

reference [url]

Search-Search parameters by types

number string join composite quantity uri(unsupported)special(unsupported)

Search-Prefixes-gt

gt with date gt with number gt with Instant gt date on Period

Search-Prefixes-ge

ge with date ge with number ge with Instant ge date on Period

Search-Prefixes-le

le with date le with number le with Instant le date on Period

Search-Prefixes-sa

sa with date sa with number sa with Instant sa date on Period

Search-Prefixes-eb

eb with date eb with number eb with Instant eb date on Period

Search-Prefixes-ap

ap with date ap with dateTime ap with Instant ap date on Period

Search-Prefixes-lt

lt with date lt with dateTime lt with Instant lt date on Period

Search-Pagination

cursor pagination

Create Location with position get location by near

_include Get resource _pretty search by POST

Operations-$everything

end & start $everything by patient id

Operations-$summary-Patient Summary

IPS Medication IPS Organization IPS Practitioner IPS Patient IPS MedicationRequest IPS MedicationStatement FHIR MedicationAdministration FHIR MedicationDispense IPS Allergyintolerance IPS Condition Past Problem IPS Procedure IPS Immunization IPS Device IPS DeviceUseStatement IPS Observation Pregnancy: outcome IPS DiagnosticReport Laboratory Results FHIR ClinicalImpression FHIR CarePlan FHIR Consent

Operations-$summary

$validate with profile in url $validate with Parameters $validate Parameters in create mode $snapshot $document via GET $document via POST Get generated document bundle $apply-fhirpath $versions

Create Subscription email Get Subscription list Get Subscription by id Post Observation (trigger subscription)

Bulk Export-Patient Level Export

Kick Off request with all parameters Kick Off request POST with all parameters

Bulk Export-System Level Export

Kick Off with type, since, elements Kick Off request POST with all parameters

Bulk Export-Group Level Export

Kick Off request with all parameters Kick Off request POST with all parameters Create group with subgroup Kick off request with no filters

Get job Delete export

Bulk import from file Get job

Сonverter-xml to json

Сonverter-json to xml

Get TerminologyCapabilities Get CapabilityStatement $subset for CapabilityStatement

Organization with extension Patient with extension

StructureDefinitions

Put SD Post SD with profile discriminator on element Search SD by url Get SD by ID Update SD Delete SD Post SearchParameter Get SearchParameter Get SearchParameter _history Update SearchParameter Delete SearchParameter

Post CodeSystem Get CodeSystem Get CodeSystem by url _summary Put CodeSystem Delete CodeSystem Post ValueSet with filter Get ValueSet Get ValueSet by url Put ValueSet Delete ValueSet Post ConceptMap Get ConceptMap Post NamingSystem Get NamingSystem by id Put NamingSystem Delete NamingSystem

Terminology Operations-ValueSet

$validate-code on ValueSet $validate-code on ValueSet by ID $validate-code on ValueSet using Parameters $validate-code on ValueSet using Parameters and ID $expand with filter parameter $expand by url $expand POST $validate ValueSet

Terminology Operations-CodeSystem

$validate-code on CodeSystem by ID $validate-code on CodeSystem $validate-code on CodeSystem using Parameters $validate-code on CodeSystem using Parameters and ID $lookup $lookup via POST $validate CodeSystem $find-matches $find-matches By ID $subsumes Parameters Coding $subsumes Parameters by ID $subsumes $subsumes with ID

Terminology Operations-ConceptMap

$translate $translate with ID $translate POST by ID $translate POST $validate ConceptMap

POST new template $convert-data HL7 v2 ADT_A01

Patient Observation Filter Observations

Transaction with terminology operations post Bundle Get job by id

KodjinResourceTool

Patient _revinclude

Organization Endpoint with Organization PractitionerRole Location Patient Medication Account AdverseEvent AllergyIntolerance Appointment AppointmentResponse AuditEvent Basic BodyStructure CarePlan CareTeam ChargeItem Coverage Claim ClaimResponse ClinicalImpression Communication CommunicationRequest Composition Condition Consent Contract CoverageEligibilityRequest CoverageEligibilityResponse DetectedIssue Device DeviceRequest DeviceUseStatement DocumentReference DocumentManifest Encounter EnrollmentRequest EpisodeOfCare ExplanationOfBenefit FamilyMemberHistory Flag Goal Group GuidanceResponse ImagingStudy Immunization ImmunizationEvaluation ImmunizationRecommendation Invoice List Measure MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement MolecularSequence NutritionOrder Observation DiagnosticReport Person Procedure Provenance QuestionnaireResponse RelatedPerson RequestGroup ResearchStudy ResearchSubject RiskAssessment Schedule ServiceRequest Specimen SupplyRequest SupplyDelivery Task VisionPrescription Patient _revinclude

Practitioner _revinclude

Organization Location Patient Practitioner Medication Copy Account AdverseEvent AllergyIntolerance Appointment AppointmentResponse AuditEvent Basic CarePlan CareTeam ChargeItem Coverage Copy Claim ClaimResponse ClinicalImpression Communication CommunicationRequest Composition Condition Consent Contract CoverageEligibilityRequest CoverageEligibilityResponse Copy DetectedIssue DocumentReference DocumentManifest Encounter EpisodeOfCare Flag Group ImagingStudy Immunization Invoice Linkage List Measure MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement NutritionOrder Observation Device Copy DeviceRequest DiagnosticReport ExplanationOfBenefit MessageHeader PaymentReconciliation PaymentNotice Person PractitionerRole Procedure Provenance QuestionnaireResponse RequestGroup ResearchStudy RiskAssessment Schedule ServiceRequest Specimen SupplyRequest SupplyDelivery Task VisionPrescription Practitioner _revinclude

PractitionerRole _revinclude

Organization Location Patient Practitioner PractitionerRole Medication Copy Account AdverseEvent AllergyIntolerance Appointment AppointmentResponse AuditEvent Basic CarePlan CareTeam ChargeItem Coverage Copy Claim ClaimResponse ClinicalImpression Communication CommunicationRequest Composition Condition Consent Contract CoverageEligibilityRequest CoverageEligibilityResponse Copy DetectedIssue Device Copy DeviceRequest Encounter DiagnosticReport DocumentReference DocumentManifest ExplanationOfBenefit Flag Group ImagingStudy Immunization Invoice Linkage List Measure MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement MessageHeader NutritionOrder Observation PaymentReconciliation PaymentNotice Procedure Provenance QuestionnaireResponse RequestGroup ResearchStudy RiskAssessment Schedule ServiceRequest Specimen SupplyRequest SupplyDelivery Task VisionPrescription PractitionerRole _revinclude

RelatedPerson _revinclude

Organization Patient RelatedPerson AdverseEvent AllergyIntolerance Appointment AppointmentResponse AuditEvent Basic CarePlan CareTeam ChargeItem Claim Communication CommunicationRequest Composition Condition Consent Contract Coverage Device DeviceRequest DocumentReference DocumentManifest Encounter ExplanationOfBenefit Group ImagingStudy Invoice MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement Observation Person Procedure Provenance QuestionnaireResponse RequestGroup Schedule ServiceRequest SupplyRequest Task RelatedPerson

Person _revinclude

Group _revinclude

Group AdverseEvent CarePlan CareTeam ChargeItem ClinicalImpression Communication CommunicationRequest Condition Consent DeviceRequest DeviceUseStatement DiagnosticReport DocumentReference DocumentManifest Encounter Flag Goal GuidanceResponse ImagingStudy Invoice List MeasureReport Media MedicationAdministration MedicationDispense MedicationRequest MedicationStatement Observation Procedure RequestGroup RiskAssessment ServiceRequest Specimen Group

Organization _revinclude

Organization Account Organization _revinclude

AllergyIntolerance _include

Organization PractitionerRole Practitioner Patient Encounter AllergyIntolerance AllergyIntolerance

Condition _include

Organization Patient Encounter Practitioner PractitionerRole RelatedPerson AdverseEvent Condition Copy Condition

Observation _include

Organization Location Practitioner Patient CarePlan Device Encounter DeviceRequest Immunization ImmunizationRecommendation DocumentReference Account QuestionnaireResponse Specimen Observation Observation _include

Home Kodjin FHIR Server API Search-Search parameters by typesjoin

join

GET {{host}}/fhir//Patient?language=FR&language=NL

Request Params

Key	Datatype	Required	Description
`language`	string
`language`	string

HEADERS

Key	Datatype	Required	Description
`prefer`	string