openapi: 3.1.0 info: title: Kodjin API version: '2026-10-14' description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-14: 17 operation(s) read from 18 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Kodjin has published no machine-readable contract that the pipeline could find. Engine: local.' x-evidence-tiers: code-example: 21 documentation: -4 pages-with-code: 16 pages-read: 18 x-generated-from: documentation x-provenance: generated x-authored-by: API Evangelist x-generated: '2026-10-14' x-generator: generate-contract-from-docs.py x-engine: local x-sources: - https://docs.kodjin.com/kodjin-restful-api - https://docs.kodjin.com/uscdi_v3/onc-kodjin-restful-api - https://docs.kodjin.com/uscdi_v3/uscdi-clinical-notes-document-reference - https://docs.kodjin.com/uscdi_v3/app-client-registration - https://docs.kodjin.com/uscdi_v3/uscdi-observation-clinical-result - https://docs.kodjin.com/operation-resource-reindex - https://docs.kodjin.com/uscdi_v3/uscdi-clinical-tests-diagnostic-report - https://docs.kodjin.com/coded_data_types - https://docs.kodjin.com/authentication-authorization - https://docs.kodjin.com/smart-on-fhir-authorization - https://docs.kodjin.com/kodjin-search - https://docs.kodjin.com/versioning - https://docs.kodjin.com/everything-on-patient - https://docs.kodjin.com/operation-validate - https://docs.kodjin.com/operation-document - https://docs.kodjin.com/operation-apply-fhirpath - https://docs.kodjin.com/opeation-versions - https://docs.kodjin.com/operation-ips servers: - url: https://sandbox.fhir.elationemr.com paths: /Patient/$validate: post: operationId: post_Patient_validate tags: - Patient summary: POST /Patient/$validate x-source: https://docs.kodjin.com/operation-validate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostPatientValidateRequest' responses: '201': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: "curl --location --request POST 'https://fhir.example.comfhir/Patient/$validate' --header 'Content-Type: application/json' \ \ --data-raw '{\n \"resourceType\": \"Parameters\",\n \"parameter\": [\n {\n \"name\": \"profile\",\n \"valueUri\": \"http://hl7.org/fhir/StructureDefinition/Patient\"\ \n },\n {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Patient\",\n \"id\": \"b095f89f-bf9c-4583-a1df-2fa0fd7a9d21\"\ ,\n \"meta\": {\n" /Patient/{patientid}: put: operationId: put_Patient_patientid tags: - Patient summary: PUT /Patient/{patientId} x-source: https://docs.kodjin.com/versioning parameters: - name: patientid in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: code-example language: http snippet: " PUT /Patient/347 HTTP/1.1\n If-Match: W/\"23\"\nIf the version ID given in the If-Match header does not match, Kodjin will\ \ return a 412 Precondition Failed status code instead of updating the resource. \n Delete \n The delete interaction does not remove\ \ a resource's version history. Though you will get 410 Gone status code accessing the deleted resource by ID, you can still perform\ \ _history or vread op" /auth/realms/fhir/clients-registrations/openid-connect: get: operationId: get_auth_realms_fhir_clients_registrations_openid_connect tags: - Auth summary: GET /auth/realms/fhir/clients-registrations/openid-connect x-source: https://docs.kodjin.com/uscdi_v3/app-client-registration responses: '200': description: Success (shape read from the example response on the page) content: application/json: schema: $ref: '#/components/schemas/GetAuthRealmsFhirClientsRegistrationsOpenidConnectResponse' x-evidence: kind: code-example language: curl snippet: 'curl --location --request GET ''https://fhir.example.com/auth/realms/fhir/clients-registrations/openid-connect'' --header ''Authorization: Bearer eyJhsGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI3ZDUyMzUxYS1mMzIyLTRjNmMtYTI1OC1lYTVlZTdjZWRiYWEifQ.eyJleHAiOjAsImlhdCI6MTY2NjU2MzcyOCwianRpIjoiNTk1OWE5OGMtMzQzYy00NzBmLWJmMTktMGJkNDdkZTIyZmYzIiwiaXNzIjoiaHR0cHM6Ly9zYW5kYm94LmZoaXIuZWxhdGlvbmVtci5jb20vY' /auth/realms/fhir/protocol/openid-connect/revoke: post: operationId: post_auth_realms_fhir_protocol_openid_connect_revoke tags: - Auth summary: POST /auth/realms/fhir/protocol/openid-connect/revoke x-source: https://docs.kodjin.com/authentication-authorization responses: '201': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: 'curl --location --request POST ''https://fhir.example.com/auth/realms/fhir/protocol/openid-connect/revoke'' --header ''Content-Type: application/x-www-form-urlencoded'' --header ''Cookie: cookie=f9dd0e1484656621'' --data-urlencode ''client_id=my-app'' --data-urlencode ''client_secret=bdmuHxjqMdh3Pr3itbLVIMhOREhXbOs'' --data-urlencode ''token=eyJhbGciOiJSUzI1wiIsS1nR5cCIgOiAiSldUIiwia2lkIiA6ICJMcEZjdWVzM' /auth/realms/fhir/protocol/openid-connect/token/introspect: post: operationId: post_auth_realms_fhir_protocol_openid_connect_token_introspect tags: - Auth summary: POST /auth/realms/fhir/protocol/openid-connect/token/introspect x-source: https://docs.kodjin.com/authentication-authorization responses: '201': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: 'curl --location --request POST ''https://fhir.example.com/auth/realms/fhir/protocol/openid-connect/token/introspect'' --header ''Content-Type: application/x-www-form-urlencoded'' --header ''Cookie: cookie=f9dd0e1484656621'' --data-urlencode ''token=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJMcEZjdWVzMzJqUFRkaF9pOFNVY0I1Tk5HenNQZDF4REc0SHZNQTlIVXJvIn0.eyJleHAiOjE2NjY1NTI3NTcsImlhdCI6MTY2NjU1MjQ' /fhir/$apply-fhirpath: post: operationId: post_fhir_apply_fhirpath tags: - Fhir summary: POST /fhir/$apply-fhirpath x-source: https://docs.kodjin.com/operation-apply-fhirpath requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostFhirApplyFhirpathRequest' responses: '201': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: "curl --location 'https://fhir.example.com/fhir/$apply-fhirpath' --header 'Content-Type: application/json' --header 'Cookie:\ \ cookie=e3f7cd66a576cbfa; session=T8mHJ0uxnck9Qb3q8qmSnA|1689349873|FATFY_uwswuASoOeva3amj_3czw' --data '{\n \"ResourceType\": \"\ Parameters\",\n \"parameter\": [\n {\n \"name\": \"fhirPath\",\n \"valueString\": \"(Medication.ingredient.isActive=true and Medication.ingredient.strength.exists(" /fhir/$reindex: post: operationId: post_fhir_reindex tags: - Fhir summary: POST /fhir/$reindex x-source: https://docs.kodjin.com/operation-resource-reindex requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostFhirReindexRequest' responses: '201': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: "curl --location 'https://fhir.example.com/fhir/$reindex' --header 'Content-Type: application/json' --data '{\n \"resourceType\"\ : \"Parameters\",\n \"parameter\": [\n {\n \"name\": \"resourceType\",\n \"valueString\": \"Patient\"\n }\n ]\n }'\n {\n \"parameter\"\ : [\n {\n \"name\": \"id\",\n \"valueString\": \"38955c06-3496-441b-8731-c2827b3a2f2f\"\n },\n {\n \"name\": \"insertedAt\",\n \"valueString\"\ : \"2025-04-01T11:46:02.735482335+00:00\"\n }" /fhir/$versions: get: operationId: get_fhir_versions tags: - Fhir summary: GET /fhir/$versions x-source: https://docs.kodjin.com/opeation-versions responses: '200': description: Success (shape read from the example response on the page) content: application/json: schema: $ref: '#/components/schemas/GetFhirVersionsResponse' x-evidence: kind: code-example language: curl snippet: "curl --location --request GET 'https://fhir.example.com/fhir/$versions' {\n \"parameter\": [\n {\n \"name\": \"version\",\n\ \ \"valueCode\": \"4.0\"\n },\n {\n \"name\": \"default\",\n \"valueCode\": \"4.0\"\n }\n ],\n \"resourceType\": \"Parameters\"\n }\n\ \ Try operation $versions with our Kodjin FHIR Server Postman Collection \n Back to top\n © EDENLAB. ALL RIGHTS RESERVED, 2021 - 2024\n\ \ powered by\n MkDocs \n and\n Material for MkDocs" /fhir/Composition/46745318-dbf3-4a2c-b70a-6d4ea85ee7fb/$document: get: operationId: get_fhir_Composition_46745318_dbf3_4a2c_b70a_6d4ea85ee7fb_document tags: - Fhir summary: GET /fhir/Composition/46745318-dbf3-4a2c-b70a-6d4ea85ee7fb/$document x-source: https://docs.kodjin.com/operation-document parameters: - name: persist in: query required: false schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: "curl --location --request GET 'https://fhir.example.com/fhir/Composition/46745318-dbf3-4a2c-b70a-6d4ea85ee7fb/$document?persist=true'\ \ Try operation $document with our Kodjin FHIR Server Postman Collection \n Back to top\n © EDENLAB. ALL RIGHTS RESERVED, 2021 - 2024\n\ \ powered by\n MkDocs \n and\n Material for MkDocs" /fhir/DocumentReference/a11b21f6-1ac7-ca23-1ba2-a021f6532a5d: get: operationId: get_fhir_DocumentReference_a11b21f6_1ac7_ca23_1ba2_a021f6532a5d tags: - Fhir summary: GET /fhir/DocumentReference/a11b21f6-1ac7-ca23-1ba2-a021f6532a5d x-source: https://docs.kodjin.com/uscdi_v3/uscdi-clinical-notes-document-reference responses: '200': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: "curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/DocumentReference/a11b21f6-1ac7-ca23-1ba2-a021f6532a5d'\ \ --header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'\n DocumentReference By patient \n Search for All DocumentReference\ \ by a specific patient. \n METHOD GET \n GET [base url]/DocumentReference?patient={Type/}[id]\n PARAMS \n [base url] - FHIR base url\ \ \n {Type/" /fhir/Patient/$validate: post: operationId: post_fhir_Patient_validate tags: - Fhir summary: POST /fhir/Patient/$validate x-source: https://docs.kodjin.com/operation-validate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostFhirPatientValidateRequest' responses: '201': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: "curl --location --request POST 'https://fhir.example.com/fhir/Patient/$validate' --header 'Content-Type: application/json'\ \ --data-raw '{\n \"resourceType\": \"Patient\",\n \"id\": \"b095f89f-bf9c-4583-a1df-2fa0fd7a9d21\",\n \"meta\": {\n \"source\": \"\ b095f89f-bf9c-4583-a1df-2fa0fd7a9d21\",\n \"versionId\": \"1\",\n \"lastUpdated\": \"2022-09-20T07:47:49.390+00:00\"\n },\n \"identifier\"\ : [\n {\n \"type\": {\n \"coding\": [\n {\n \"syst" /fhir/Patient/8a215a7f-2428-45fd-9ed2-88ec672d5158/$summary: get: operationId: get_fhir_Patient_8a215a7f_2428_45fd_9ed2_88ec672d5158_summary tags: - Fhir summary: GET /fhir/Patient/8a215a7f-2428-45fd-9ed2-88ec672d5158/$summary x-source: https://docs.kodjin.com/operation-ips responses: '200': description: Success (shape read from the example response on the page) content: application/json: schema: $ref: '#/components/schemas/GetFhirPatient8A215A7F242845Fd9Ed288Ec672D5158SummaryRespons' x-evidence: kind: code-example language: curl snippet: "curl --location 'https://fhir.example.com/fhir/Patient/8a215a7f-2428-45fd-9ed2-88ec672d5158/$summary'\n {\n \"resourceType\"\ : \"Bundle\",\n \"type\": \"document\",\n \"entry\": [\n {\n \"fullUrl\": \"urn:uuid:1efba9cd-4059-42df-a6f9-a197221020b8\",\n \"resource\"\ : {\n \"resourceType\": \"Composition\",\n \"id\": \"1efba9cd-4059-42df-a6f9-a197221020b8\",\n \"author\": [\n {\n \"reference\": \"\ Organization/kodjin\"\n }\n ],\n \"date\": \"2024-04-" /fhir/Patient/ac5b5b83-8c6a-43c9-98cd-0ce842b888ad: patch: operationId: patch_fhir_Patient_ac5b5b83_8c6a_43c9_98cd_0ce842b888ad tags: - Fhir summary: PATCH /fhir/Patient/ac5b5b83-8c6a-43c9-98cd-0ce842b888ad x-source: https://docs.kodjin.com/kodjin-restful-api requestBody: required: true content: application/json: schema: type: array items: type: object properties: op: type: string path: type: string value: type: array items: {} responses: '200': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: "curl --location --request PATCH 'https://fhir.example.com/fhir/Patient/ac5b5b83-8c6a-43c9-98cd-0ce842b888ad' --header 'content-type:\ \ application/json-patch+json' --data-raw '[\n { \"op\": \"add\", \"path\": \"/address\", \"value\":[]},\n { \"op\": \"add\", \"path\"\ : \"/address/0\", \"value\":\n {\n \"use\" : \"home\",\n \"line\" : [\"23 thule st\",\"avon\"],\n \"city\" : \"Springfield\",\n \"country\"\ \ : \"USA\",\n \"text\":\"23 thule st\"\n }\n }" /fhir/Patient/{patientid}: get: operationId: get_fhir_Patient_patientid tags: - Fhir summary: Example -Request x-source: https://docs.kodjin.com/smart-on-fhir-authorization parameters: - name: patientid in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation collapsed_from: 2 example path(s) differing only at patientId /fhir/reindex/{reindexid}: get: operationId: get_fhir_reindex_reindexid tags: - Fhir summary: GET /fhir/reindex/38955c06-3496-441b-8731-c2827b3a2f2f x-source: https://docs.kodjin.com/operation-resource-reindex parameters: - name: reindexid in: path required: true schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: "curl --location --request GET 'https://fhir.example.com/fhir/reindex/38955c06-3496-441b-8731-c2827b3a2f2f' \n }\n {\n \"parameter\"\ : [\n {\n \"name\": \"id\",\n \"valueString\": \"38955c06-3496-441b-8731-c2827b3a2f2f\"\n },\n {\n \"name\": \"insertedAt\",\n \"valueString\"\ : \"2025-04-01T11:46:02.735+00:00\"\n },\n {\n \"name\": \"updatedAt\",\n \"valueString\": \"2025-04-01T11:46:14.718+00:00\"\n },\n\ \ {\n \"name\": \"status\",\n \"valueString\": " collapsed_from: 3 example path(s) differing only at reindexId /fhir/{fhirid}: get: operationId: get_fhir_fhirid tags: - Fhir summary: FHIR Search Operations description: Search operation to fetch Condition resources. The response is a Bundle of resources or an OperationOutcome. x-source: https://docs.kodjin.com/kodjin-search parameters: - name: fhirid in: path required: true schema: type: string - name: patient in: query required: false schema: type: string responses: '200': description: Success (status as documented) x-evidence: kind: documentation collapsed_from: 5 example path(s) differing only at fhirId /terminology/ValueSet/clinical-findings/$expand: get: operationId: get_terminology_ValueSet_clinical_findings_expand tags: - Terminology summary: GET /terminology/ValueSet/clinical-findings/$expand x-source: https://docs.kodjin.com/coded_data_types responses: '200': description: Success (status as documented) x-evidence: kind: code-example language: curl snippet: "curl --location --request GET 'https://fhir.example.com/terminology/ValueSet/clinical-findings/$expand'\n Thus, coded data types\ \ in FHIR can be presented through a code , coding , or codeableConcept data type. \nCoding and CodeableConcept references a Code System\ \ that assigns codes representing the concepts in the system, such as LOINC or SNOMED. The Value Set defines a context in which a CodeSystem" components: schemas: PostPatientValidateRequest: type: object properties: resourceType: type: string parameter: type: array items: type: object properties: name: type: string valueUri: type: string GetAuthRealmsFhirClientsRegistrationsOpenidConnectResponse: type: object properties: redirect_uris: type: array items: {} token_endpoint_auth_method: type: string grant_types: type: array items: type: string response_types: type: array items: type: string client_id: type: string client_secret: type: string client_name: type: string scope: type: string subject_type: type: string request_uris: type: array items: {} tls_client_certificate_bound_access_tokens: type: boolean client_id_issued_at: type: integer client_secret_expires_at: type: integer registration_client_uri: type: string registration_access_token: type: string backchannel_logout_session_required: type: boolean require_pushed_authorization_requests: type: boolean PostFhirApplyFhirpathRequest: type: object properties: ResourceType: type: string parameter: type: array items: type: object properties: name: type: string valueString: type: string PostFhirReindexRequest: type: object properties: resourceType: type: string parameter: type: array items: type: object properties: name: type: string valueString: type: string GetFhirVersionsResponse: type: object properties: parameter: type: array items: type: object properties: name: type: string valueCode: type: string resourceType: type: string PostFhirPatientValidateRequest: type: object properties: resourceType: type: string id: type: string meta: type: object properties: source: type: string versionId: type: string lastUpdated: type: string format: date-time identifier: type: array items: type: object properties: type: type: object properties: coding: type: array items: type: object properties: system: type: string code: type: string display: type: string system: type: string value: type: string active: type: boolean name: type: array items: type: object properties: use: type: string text: type: string family: type: string given: type: array items: type: string telecom: type: array items: type: object properties: system: type: string value: type: string use: type: string gender: type: string birthDate: type: string format: date managingOrganization: type: object properties: reference: type: string GetFhirPatient8A215A7F242845Fd9Ed288Ec672D5158SummaryRespons: type: object properties: reference: type: string securitySchemes: bearer: type: http scheme: bearer security: - bearer: [] tags: - name: Auth - name: Fhir - name: Patient - name: Terminology