Qodex.ai
Qodex.ai
Introduction
Kodjin FHIR Server API
CRUDs
Create FHIR ResourceGet FHIR ResourceSearch FHIR Resource by _idUpdate FHIR ResourceFHIRPath PatchDelete FHIR Resource
FHIR Resources-General resources
OrganizationGet Organization by idEndpointEndpoint CopyPractitionerLocationMedicationDevicePost EnrollmentResponse
FHIR Resources-Patient Compartment
Patient with fixed OrganizationCoverageAccountAuditEventAppointmentAppointmentResponseAllergyIntoleranceConditionClaimCare TeamClaim ResponseObservation(Quantity)EncounterDiagnosticReportCreate compositionImagingStudyImmunizationEnrollmentResponseMedicationRequestMedicationStatementMedicationAdministrationMedicationDispenseProcedureDocumentReferenceServiceRequestSupplyRequestProvenanceRiskAssessmentExplanationOfBenefitGroupDevice
Conditional Create\Update\Delete
UpsertConditional Update SearchConditional Delete SearchConditional Post
Versioning
vread_history by id with _at_history search with _since param_history by resource type with _at param
Search-Global search parameters
_source
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
:of-type:type
Search-Search parameters by types-date
date on datedate on dateTimedate on Instantdate on Perioddate on Timimg
Search-Search parameters by types-token
token on Codingtoken on CodeableConcepttoken on string
Search-Search parameters by types-reference
reference [url]
Search-Search parameters by types
numberstringjoincompositequantityuri(unsupported)special(unsupported)
Search-Prefixes-gt
gt with dategt with numbergt with Instantgt date on Period
Search-Prefixes-ge
ge with datege with numberge with Instantge date on Period
Search-Prefixes-le
le with datele with numberle with Instantle date on Period
Search-Prefixes-sa
sa with datesa with numbersa with Instantsa date on Period
Search-Prefixes-eb
eb with dateeb with numbereb with Instanteb date on Period
Search-Prefixes-ap
ap with dateap with dateTimeap with Instantap date on Period
Search-Prefixes-lt
lt with datelt with dateTimelt with Instantlt date on Period
Search-Pagination
cursor pagination
Search-near
Create Location with positionget location by near
Search
_includeGet resource _prettysearch by POST
Operations-$everything
end & start$everything by patient id
Operations-$summary-Patient Summary
IPS MedicationIPS OrganizationIPS PractitionerIPS PatientIPS MedicationRequestIPS MedicationStatementFHIR MedicationAdministrationFHIR MedicationDispenseIPS AllergyintoleranceIPS Condition Past ProblemIPS ProcedureIPS ImmunizationIPS DeviceIPS DeviceUseStatementIPS Observation Pregnancy: outcomeIPS DiagnosticReport Laboratory ResultsFHIR ClinicalImpressionFHIR CarePlanFHIR Consent
Operations-$summary
$summary
Operations
$validate with profile in url$validate with Parameters$validate Parameters in create mode$snapshot$document via GET$document via POSTGet generated document bundle$apply-fhirpath$versions
Subscriptions
Create Subscription emailGet Subscription listGet Subscription by idPost Observation (trigger subscription)
Bulk Export-Patient Level Export
Kick Off request with all parametersKick Off request POST with all parameters
Bulk Export-System Level Export
Kick Off with type, since, elementsKick Off request POST with all parameters
Bulk Export-Group Level Export
Kick Off request with all parametersKick Off request POST with all parametersCreate group with subgroupKick off request with no filters
Bulk Export
Get jobDelete export
Bulk Import
Bulk import from fileGet job
Сonverter-xml to json
Bundle
Сonverter-json to xml
Bundle
Metadata
Get TerminologyCapabilitiesGet CapabilityStatement$subset for CapabilityStatement
Extension
Organization with extensionPatient with extension
StructureDefinitions
Put SDPost SD with profile discriminator on elementSearch SD by urlGet SD by IDUpdate SDDelete SDPost SearchParameterGet SearchParameterGet SearchParameter _historyUpdate SearchParameterDelete SearchParameter
Terminology
Post CodeSystemGet CodeSystemGet CodeSystem by url_summaryPut CodeSystemDelete CodeSystemPost ValueSet with filterGet ValueSetGet ValueSet by urlPut ValueSetDelete ValueSetPost ConceptMapGet ConceptMapPost NamingSystemGet NamingSystem by idPut NamingSystemDelete 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
mapper
POST new template$convert-data HL7 v2 ADT_A01
UCUM
PatientObservationFilter Observations
Bundles
Transaction with terminology operationspost BundleGet job by id
KodjinResourceTool
Patient _revinclude
OrganizationEndpoint with OrganizationPractitionerRoleLocationPatientMedicationAccountAdverseEventAllergyIntoleranceAppointmentAppointmentResponseAuditEventBasicBodyStructureCarePlanCareTeamChargeItemCoverageClaimClaimResponseClinicalImpressionCommunicationCommunicationRequestCompositionConditionConsentContractCoverageEligibilityRequestCoverageEligibilityResponseDetectedIssueDeviceDeviceRequestDeviceUseStatementDocumentReferenceDocumentManifestEncounterEnrollmentRequestEpisodeOfCareExplanationOfBenefitFamilyMemberHistoryFlagGoalGroupGuidanceResponseImagingStudyImmunizationImmunizationEvaluationImmunizationRecommendationInvoiceListMeasureMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementMolecularSequenceNutritionOrderObservationDiagnosticReportPersonProcedureProvenanceQuestionnaireResponseRelatedPersonRequestGroupResearchStudyResearchSubjectRiskAssessmentScheduleServiceRequestSpecimenSupplyRequestSupplyDeliveryTaskVisionPrescriptionPatient _revinclude
Practitioner _revinclude
OrganizationLocationPatientPractitionerMedication CopyAccountAdverseEventAllergyIntoleranceAppointmentAppointmentResponseAuditEventBasicCarePlanCareTeamChargeItemCoverage CopyClaimClaimResponseClinicalImpressionCommunicationCommunicationRequestCompositionConditionConsentContractCoverageEligibilityRequestCoverageEligibilityResponse CopyDetectedIssueDocumentReferenceDocumentManifestEncounterEpisodeOfCareFlagGroupImagingStudyImmunizationInvoiceLinkageListMeasureMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementNutritionOrderObservationDevice CopyDeviceRequestDiagnosticReportExplanationOfBenefitMessageHeaderPaymentReconciliationPaymentNoticePersonPractitionerRoleProcedureProvenanceQuestionnaireResponseRequestGroupResearchStudyRiskAssessmentScheduleServiceRequestSpecimenSupplyRequestSupplyDeliveryTaskVisionPrescriptionPractitioner _revinclude
PractitionerRole _revinclude
OrganizationLocationPatientPractitionerPractitionerRoleMedication CopyAccountAdverseEventAllergyIntoleranceAppointmentAppointmentResponseAuditEventBasicCarePlanCareTeamChargeItemCoverage CopyClaimClaimResponseClinicalImpressionCommunicationCommunicationRequestCompositionConditionConsentContractCoverageEligibilityRequestCoverageEligibilityResponse CopyDetectedIssueDevice CopyDeviceRequestEncounterDiagnosticReportDocumentReferenceDocumentManifestExplanationOfBenefitFlagGroupImagingStudyImmunizationInvoiceLinkageListMeasureMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementMessageHeaderNutritionOrderObservationPaymentReconciliationPaymentNoticeProcedureProvenanceQuestionnaireResponseRequestGroupResearchStudyRiskAssessmentScheduleServiceRequestSpecimenSupplyRequestSupplyDeliveryTaskVisionPrescriptionPractitionerRole _revinclude
RelatedPerson _revinclude
OrganizationPatientRelatedPersonAdverseEventAllergyIntoleranceAppointmentAppointmentResponseAuditEventBasicCarePlanCareTeamChargeItemClaimCommunicationCommunicationRequestCompositionConditionConsentContractCoverageDeviceDeviceRequestDocumentReferenceDocumentManifestEncounterExplanationOfBenefitGroupImagingStudyInvoiceMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementObservationPersonProcedureProvenanceQuestionnaireResponseRequestGroupScheduleServiceRequestSupplyRequestTaskRelatedPerson
Person _revinclude
PersonPerson
Group _revinclude
GroupAdverseEventCarePlanCareTeamChargeItemClinicalImpressionCommunicationCommunicationRequestConditionConsentDeviceRequestDeviceUseStatementDiagnosticReportDocumentReferenceDocumentManifestEncounterFlagGoalGuidanceResponseImagingStudyInvoiceListMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementObservationProcedureRequestGroupRiskAssessmentServiceRequestSpecimenGroup
Organization _revinclude
OrganizationAccountOrganization _revinclude
AllergyIntolerance _include
OrganizationPractitionerRolePractitionerPatientEncounterAllergyIntoleranceAllergyIntolerance
Condition _include
OrganizationPatientEncounterPractitionerPractitionerRoleRelatedPersonAdverseEventCondition CopyCondition
Observation _include
OrganizationLocationPractitionerPatientCarePlanDeviceEncounterDeviceRequestImmunizationImmunizationRecommendationDocumentReferenceAccountQuestionnaireResponseSpecimenObservationObservation _include
Introduction
Kodjin FHIR Server API
CRUDs
Create FHIR ResourceGet FHIR ResourceSearch FHIR Resource by _idUpdate FHIR ResourceFHIRPath PatchDelete FHIR Resource
FHIR Resources-General resources
OrganizationGet Organization by idEndpointEndpoint CopyPractitionerLocationMedicationDevicePost EnrollmentResponse
FHIR Resources-Patient Compartment
Patient with fixed OrganizationCoverageAccountAuditEventAppointmentAppointmentResponseAllergyIntoleranceConditionClaimCare TeamClaim ResponseObservation(Quantity)EncounterDiagnosticReportCreate compositionImagingStudyImmunizationEnrollmentResponseMedicationRequestMedicationStatementMedicationAdministrationMedicationDispenseProcedureDocumentReferenceServiceRequestSupplyRequestProvenanceRiskAssessmentExplanationOfBenefitGroupDevice
Conditional Create\Update\Delete
UpsertConditional Update SearchConditional Delete SearchConditional Post
Versioning
vread_history by id with _at_history search with _since param_history by resource type with _at param
Search-Global search parameters
_source
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
:of-type:type
Search-Search parameters by types-date
date on datedate on dateTimedate on Instantdate on Perioddate on Timimg
Search-Search parameters by types-token
token on Codingtoken on CodeableConcepttoken on string
Search-Search parameters by types-reference
reference [url]
Search-Search parameters by types
numberstringjoincompositequantityuri(unsupported)special(unsupported)
Search-Prefixes-gt
gt with dategt with numbergt with Instantgt date on Period
Search-Prefixes-ge
ge with datege with numberge with Instantge date on Period
Search-Prefixes-le
le with datele with numberle with Instantle date on Period
Search-Prefixes-sa
sa with datesa with numbersa with Instantsa date on Period
Search-Prefixes-eb
eb with dateeb with numbereb with Instanteb date on Period
Search-Prefixes-ap
ap with dateap with dateTimeap with Instantap date on Period
Search-Prefixes-lt
lt with datelt with dateTimelt with Instantlt date on Period
Search-Pagination
cursor pagination
Search-near
Create Location with positionget location by near
Search
_includeGet resource _prettysearch by POST
Operations-$everything
end & start$everything by patient id
Operations-$summary-Patient Summary
IPS MedicationIPS OrganizationIPS PractitionerIPS PatientIPS MedicationRequestIPS MedicationStatementFHIR MedicationAdministrationFHIR MedicationDispenseIPS AllergyintoleranceIPS Condition Past ProblemIPS ProcedureIPS ImmunizationIPS DeviceIPS DeviceUseStatementIPS Observation Pregnancy: outcomeIPS DiagnosticReport Laboratory ResultsFHIR ClinicalImpressionFHIR CarePlanFHIR Consent
Operations-$summary
$summary
Operations
$validate with profile in url$validate with Parameters$validate Parameters in create mode$snapshot$document via GET$document via POSTGet generated document bundle$apply-fhirpath$versions
Subscriptions
Create Subscription emailGet Subscription listGet Subscription by idPost Observation (trigger subscription)
Bulk Export-Patient Level Export
Kick Off request with all parametersKick Off request POST with all parameters
Bulk Export-System Level Export
Kick Off with type, since, elementsKick Off request POST with all parameters
Bulk Export-Group Level Export
Kick Off request with all parametersKick Off request POST with all parametersCreate group with subgroupKick off request with no filters
Bulk Export
Get jobDelete export
Bulk Import
Bulk import from fileGet job
Сonverter-xml to json
Bundle
Сonverter-json to xml
Bundle
Metadata
Get TerminologyCapabilitiesGet CapabilityStatement$subset for CapabilityStatement
Extension
Organization with extensionPatient with extension
StructureDefinitions
Put SDPost SD with profile discriminator on elementSearch SD by urlGet SD by IDUpdate SDDelete SDPost SearchParameterGet SearchParameterGet SearchParameter _historyUpdate SearchParameterDelete SearchParameter
Terminology
Post CodeSystemGet CodeSystemGet CodeSystem by url_summaryPut CodeSystemDelete CodeSystemPost ValueSet with filterGet ValueSetGet ValueSet by urlPut ValueSetDelete ValueSetPost ConceptMapGet ConceptMapPost NamingSystemGet NamingSystem by idPut NamingSystemDelete 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
mapper
POST new template$convert-data HL7 v2 ADT_A01
UCUM
PatientObservationFilter Observations
Bundles
Transaction with terminology operationspost BundleGet job by id
KodjinResourceTool
Patient _revinclude
OrganizationEndpoint with OrganizationPractitionerRoleLocationPatientMedicationAccountAdverseEventAllergyIntoleranceAppointmentAppointmentResponseAuditEventBasicBodyStructureCarePlanCareTeamChargeItemCoverageClaimClaimResponseClinicalImpressionCommunicationCommunicationRequestCompositionConditionConsentContractCoverageEligibilityRequestCoverageEligibilityResponseDetectedIssueDeviceDeviceRequestDeviceUseStatementDocumentReferenceDocumentManifestEncounterEnrollmentRequestEpisodeOfCareExplanationOfBenefitFamilyMemberHistoryFlagGoalGroupGuidanceResponseImagingStudyImmunizationImmunizationEvaluationImmunizationRecommendationInvoiceListMeasureMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementMolecularSequenceNutritionOrderObservationDiagnosticReportPersonProcedureProvenanceQuestionnaireResponseRelatedPersonRequestGroupResearchStudyResearchSubjectRiskAssessmentScheduleServiceRequestSpecimenSupplyRequestSupplyDeliveryTaskVisionPrescriptionPatient _revinclude
Practitioner _revinclude
OrganizationLocationPatientPractitionerMedication CopyAccountAdverseEventAllergyIntoleranceAppointmentAppointmentResponseAuditEventBasicCarePlanCareTeamChargeItemCoverage CopyClaimClaimResponseClinicalImpressionCommunicationCommunicationRequestCompositionConditionConsentContractCoverageEligibilityRequestCoverageEligibilityResponse CopyDetectedIssueDocumentReferenceDocumentManifestEncounterEpisodeOfCareFlagGroupImagingStudyImmunizationInvoiceLinkageListMeasureMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementNutritionOrderObservationDevice CopyDeviceRequestDiagnosticReportExplanationOfBenefitMessageHeaderPaymentReconciliationPaymentNoticePersonPractitionerRoleProcedureProvenanceQuestionnaireResponseRequestGroupResearchStudyRiskAssessmentScheduleServiceRequestSpecimenSupplyRequestSupplyDeliveryTaskVisionPrescriptionPractitioner _revinclude
PractitionerRole _revinclude
OrganizationLocationPatientPractitionerPractitionerRoleMedication CopyAccountAdverseEventAllergyIntoleranceAppointmentAppointmentResponseAuditEventBasicCarePlanCareTeamChargeItemCoverage CopyClaimClaimResponseClinicalImpressionCommunicationCommunicationRequestCompositionConditionConsentContractCoverageEligibilityRequestCoverageEligibilityResponse CopyDetectedIssueDevice CopyDeviceRequestEncounterDiagnosticReportDocumentReferenceDocumentManifestExplanationOfBenefitFlagGroupImagingStudyImmunizationInvoiceLinkageListMeasureMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementMessageHeaderNutritionOrderObservationPaymentReconciliationPaymentNoticeProcedureProvenanceQuestionnaireResponseRequestGroupResearchStudyRiskAssessmentScheduleServiceRequestSpecimenSupplyRequestSupplyDeliveryTaskVisionPrescriptionPractitionerRole _revinclude
RelatedPerson _revinclude
OrganizationPatientRelatedPersonAdverseEventAllergyIntoleranceAppointmentAppointmentResponseAuditEventBasicCarePlanCareTeamChargeItemClaimCommunicationCommunicationRequestCompositionConditionConsentContractCoverageDeviceDeviceRequestDocumentReferenceDocumentManifestEncounterExplanationOfBenefitGroupImagingStudyInvoiceMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementObservationPersonProcedureProvenanceQuestionnaireResponseRequestGroupScheduleServiceRequestSupplyRequestTaskRelatedPerson
Person _revinclude
PersonPerson
Group _revinclude
GroupAdverseEventCarePlanCareTeamChargeItemClinicalImpressionCommunicationCommunicationRequestConditionConsentDeviceRequestDeviceUseStatementDiagnosticReportDocumentReferenceDocumentManifestEncounterFlagGoalGuidanceResponseImagingStudyInvoiceListMeasureReportMediaMedicationAdministrationMedicationDispenseMedicationRequestMedicationStatementObservationProcedureRequestGroupRiskAssessmentServiceRequestSpecimenGroup
Organization _revinclude
OrganizationAccountOrganization _revinclude
AllergyIntolerance _include
OrganizationPractitionerRolePractitionerPatientEncounterAllergyIntoleranceAllergyIntolerance
Condition _include
OrganizationPatientEncounterPractitionerPractitionerRoleRelatedPersonAdverseEventCondition CopyCondition
Observation _include
OrganizationLocationPractitionerPatientCarePlanDeviceEncounterDeviceRequestImmunizationImmunizationRecommendationDocumentReferenceAccountQuestionnaireResponseSpecimenObservationObservation _include
HomeKodjin FHIR Server APITerminologyGet ValueSet by url

Get ValueSet by url

GET {{host}}/terminology/ValueSet?url=http://hl7.org/fhir/ValueSet/abstract-types

Request Params

KeyDatatypeRequiredDescription
urlstring

HEADERS

KeyDatatypeRequiredDescription
preferstring
Previous
Get ValueSet
Next
Put ValueSet