### FHIR IG Build Command Example Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Task-cdex-task-example7 This command initiates the build process for a FHIR Implementation Guide. It typically requires specifying the IG's source directory and the desired output format. ```shell tx build --ig ./ --template IG ``` -------------------------------- ### Java FHIR IG Publication Example Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Task-cdex-task-example7 This Java code snippet demonstrates publishing a FHIR Implementation Guide using the HAPI FHIR library. It involves loading the IG and then publishing it to a FHIR server. ```java IGPublisher publisher = new IGPublisher(new File("/path/to/ig.zip")); publisher.publish(new FHIRRestfulClientFactory(new FhirContext()).getRestfulClient(new HttpUrl("http://hapi.fhir.org/baseR4"))); ``` -------------------------------- ### Shell - FHIR IG Build Command Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Parameters-cdex-parameters-example3 This snippet shows a command-line instruction, likely executed in a shell environment, to build a FHIR Implementation Guide. It specifies input and output directories for the IG. ```shell # Example command to build a FHIR IG using a hypothetical 'fhir-ig-builder' tool # fhir-ig-builder --ig-path ./my-ig --output-path ./built-ig ``` -------------------------------- ### GET /websites/build_fhir_ig_hl7_davinci-ecdx/Content Source: https://build.fhir.org/ig/HL7/davinci-ecdx/signed-searchset-bundle-example Retrieves content related to the DaVinci eCDX FHIR Implementation Guide. This endpoint might be used to fetch specific resource definitions or metadata. ```APIDOC ## GET /websites/build_fhir_ig_hl7_davinci-ecdx/Content ### Description Retrieves content related to the DaVinci eCDX FHIR Implementation Guide. This endpoint might be used to fetch specific resource definitions or metadata. ### Method GET ### Endpoint /websites/build_fhir_ig_hl7_davinci-ecdx/Content ### Parameters #### Query Parameters - **_format** (string) - Optional - Specifies the desired response format (e.g., application/json, application/xml). ### Request Example ``` GET /websites/build_fhir_ig_hl7_davinci-ecdx/Content?_format=application/json ``` ### Response #### Success Response (200) - **resource** (object) - The requested resource content, typically in JSON or XML format. - **content** (array) - An array of content items, each potentially containing details about resources, metadata, or documentation. #### Response Example ```json { "resourceType": "Bundle", "entry": [ { "fullUrl": "http://hapi.fhir.org/baseR4/Condition/4ac41715-fcbd-421c-8796-9b2c9706dd3f", "resource": { "resourceType": "Condition", "id": "4ac41715-fcbd-421c-8796-9b2c9706dd3f", "meta": { "lastUpdated": "2020-04-28T20:28:00.008+00:00", "versionId": "10" }, "onsetDateTime": "2018-10-21T21:22:15-07:00", "recordedDate": "2018-10-21T21:22:15-07:00", "resourceType": "Condition", "subject": { "reference": "http://example.org/cdex/provider/fhir/Patient/06e1f0dd-5fbe-4480-9bb4-6b54ec02d31b" }, "text": { "div": "

Generated Narrative: Condition 4ac41715-fcbd-421c-8796-9b2c9706dd3f

version: 10; Last updated: 2020-04-28T20:28:00.008+00:00

" } }, "search": { "mode": "match" } } ] } ``` ``` -------------------------------- ### Python - FHIR IG Build Process Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Parameters-cdex-parameters-example3 This snippet outlines a Python-based process for building a FHIR Implementation Guide. It likely involves invoking external tools or libraries to process FHIR resources and generate the IG. ```python import os import subprocess def build_fhir_ig(ig_dir, output_dir): # Assuming 'ig_builder' is a command-line tool or script command = ["ig_builder", "-i", ig_dir, "-o", output_dir] try: subprocess.run(command, check=True) print(f"FHIR IG built successfully in {output_dir}") except subprocess.CalledProcessError as e: print(f"Error building FHIR IG: {e}") # Example usage: # ig_source_directory = "/path/to/your/ig/source" # ig_output_directory = "/path/to/your/ig/output" # build_fhir_ig(ig_source_directory, ig_output_directory) ``` -------------------------------- ### FHIR Provenance Resource Example (Turtle) Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Bundle-cdex-searchbundle-provenance-example An incomplete FHIR Provenance resource example, identified by its ID. The provided snippet indicates the start of the resource definition, typically used to record information about the origin and management of FHIR data. ```turtle @prefix fhir: . @prefix xsd: . @prefix rdf: . @prefix sct: . a fhir:Provenance ; fhir:id [ fhir:v "b2ce4584-b213-411b-bdc9-d515dc92eadf"] ; fhir:text [ fhir:status [ fhir:v "generated" ] ; ``` -------------------------------- ### FHIR Parameters Example for DaVinci CDex Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Parameters-cdex-parameters-example3 This snippet defines a FHIR Parameters resource, a common pattern for passing a set of values between systems. It includes identifiers for tracking, payer, organization, provider, and member, along with service date and an attached document reference. The structure is specific to the DaVinci CDex implementation guide. ```turtle a fhir:Parameters ; fhir:nodeRole fhir:treeRoot ; fhir:parameter ( [ fhir:name [ fhir:v "TrackingId" ] ; fhir:value [ a fhir:Identifier ; fhir:system [ fhir:v "http://example.org/payer-acns"^^xsd:anyURI ] ; fhir:value [ fhir:v "trackingid123" ] ] ] [ fhir:name [ fhir:v "AttachTo" ] ; fhir:value [ a fhir:code ; fhir:v "claim" ] ] [ fhir:name [ fhir:v "PayerId" ] ; fhir:value [ a fhir:Identifier ; fhir:system [ fhir:v "http://example.org/cdex/payer-ids"^^xsd:anyURI ] ; fhir:value [ fhir:v "payer123" ] ] ] [ fhir:name [ fhir:v "OrganizationId" ] ; fhir:value [ a fhir:Identifier ; fhir:system [ fhir:v "http://hl7.org/fhir/sid/us-npi"^^xsd:anyURI ] ; fhir:value [ fhir:v "1407071236" ] ] ] [ fhir:name [ fhir:v "ProviderId" ] ; fhir:value [ a fhir:Identifier ; fhir:system [ fhir:v "http://hl7.org/fhir/sid/us-npi"^^xsd:anyURI ] ; fhir:value [ fhir:v "9941339108" ] ] ] [ fhir:name [ fhir:v "MemberId" ] ; fhir:value [ a fhir:Identifier ; fhir:system [ fhir:v "http://example.org/cdex/member-ids"^^xsd:anyURI ] ; fhir:value [ fhir:v "234567" ] ] ] [ fhir:name [ fhir:v "ServiceDate" ] ; fhir:value [ a fhir:dateTime ; fhir:v "2022-06-16"^^xsd:date ] ] [ fhir:name [ fhir:v "Attachment" ] ; fhir:part ( [ fhir:name [ fhir:v "LineItem" ] ; fhir:value [ a fhir:string ; fhir:v "1" ] ] [ fhir:name [ fhir:v "Code" ] ; fhir:value [ a fhir:CodeableConcept ; fhir:coding ( [ a loinc:11506-3 ; fhir:system [ fhir:v "http://loinc.org"^^xsd:anyURI ] ; fhir:code [ fhir:v "11506-3" ] ; fhir:display [ fhir:v "Progress note" ] ] ) ; fhir:text [ fhir:v "Progress note" ] ] ] [ fhir:name [ fhir:v "Content" ] ; fhir:Parameters.parameter.resource ( [ a fhir:DocumentReference ; fhir:id [ fhir:v "cdex-example-doc1" ] ; fhir:status [ fhir:v "current" ] ; fhir:type [ fhir:coding ( [ a loinc:11506-3 ; fhir:system [ fhir:v "http://loinc.org"^^xsd:anyURI ] ; fhir:code [ fhir:v "11506-3" ] ; fhir:display [ fhir:v "Progress note" ] ] ) ; fhir:text [ fhir:v "Progress note" ] ] ; fhir:category ( [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category"^^xsd:anyURI ] ; fhir:code [ fhir:v "clinical-note" ] ; fhir:display [ fhir:v "Clinical Note" ] ] ) ; fhir:text [ fhir:v "Clinical Note 1" ] ] ) ; fhir:subject [ fhir:identifier [ fhir:system [ fhir:v "http://example.org/cdex/member-ids"^^xsd:anyURI ] ; fhir:value [ fhir:v "234567" ] ] ] ; fhir:date [ fhir:v "2021-12-03T18:30:56-08:00"^^xsd:dateTime ] ; fhir:content ( [ fhir:attachment [ fhir:contentType [ fhir:v "application/pdf" ] ; ``` -------------------------------- ### FHIR ServiceRequest Example (Turtle) Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Task-cdex-task-example3 This snippet shows an example of a FHIR ServiceRequest resource represented in Turtle format. It includes details about the requester, owner, purpose, inputs, and outputs of a service. ```turtle http://example.org/fhir/ServiceRequest/cdex-example-servicerequest a fhir:ServiceRequest ; fhir:id [ fhir:v "cdex-example-servicerequest"] ; fhir:status [ fhir:v "active"] ; fhir:intent [ fhir:v "order"] ; fhir:category ( [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-category"^^xsd:anyURI ] ; fhir:code [ fhir:v "data-request" ] ] ) ] ) ; fhir:code [ fhir:coding ( [ fhir:system [ fhir:v "http://example.org/cdex/payer/service-codes"^^xsd:anyURI ] ; fhir:code [ fhir:v "MB" ] ; fhir:display [ fhir:v "Member Number" ] ] ) ; fhir:text [ fhir:v "Member Number" ] ] ; fhir:subject [ fhir:link ; fhir:reference [ fhir:v "http://example.org/fhir/Patient/cdex-example-patient" ] ] ; fhir:encounter [ fhir:link ; fhir:reference [ fhir:v "http://example.org/fhir/Encounter/cdex-example-encounter" ] ] ; fhir:occurrenceDateTime [ fhir:v "2020-10-26T02:58:55.179Z"^^xsd:dateTime] ; fhir:authoredOn [ fhir:v "2020-10-26T02:58:55.179Z"^^xsd:dateTime] ; fhir:lastModified [ fhir:v "2020-10-26T04:04:52.019Z"^^xsd:dateTime] ; fhir:requester [ fhir:identifier [ fhir:system [ fhir:v "http://example.org/cdex/payer/payer-ids"^^xsd:anyURI ] ; fhir:value [ fhir:v "Payer123" ] ] ] ; fhir:owner [ fhir:identifier [ fhir:system [ fhir:v "http://hl7.org/fhir/sid/us-npi"^^xsd:anyURI ] ; fhir:value [ fhir:v "9941339108" ] ] ] ; fhir:reasonReference [ fhir:identifier [ fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/v2-0203"^^xsd:anyURI ] ; fhir:code [ fhir:v "FILL" ] ; fhir:display [ fhir:v "Filler Identifier" ] ] ) ; fhir:text [ fhir:v "Payer Claim ID" ] ] ; fhir:system [ fhir:v "http://example.org/cdex/payer/claim-ids"^^xsd:anyURI ] ; fhir:value [ fhir:v "Claim123" ] ] ] ; fhir:input ( [ fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp"^^xsd:anyURI ] ; fhir:code [ fhir:v "data-query" ] ] ) ] ; fhir:value [ a fhir:string ; fhir:v "Condition?patient=cdex-example-patient&clinical-status=active" ] ] [ fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp"^^xsd:anyURI ] ; fhir:code [ fhir:v "purpose-of-use" ] ] ) ] ; fhir:value [ a fhir:CodeableConcept ; fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/v3-ActReason"^^xsd:anyURI ] ; fhir:code [ fhir:v "COVERAGE" ] ] ) ] ] ) ; fhir:output ( [ fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp"^^xsd:anyURI ] ; fhir:code [ fhir:v "data-value" ] ] ) ] ; fhir:value [ a fhir:Reference ; fhir:reference [ fhir:v "#results" ] ] ] ) . ``` -------------------------------- ### POST /Task Source: https://build.fhir.org/ig/HL7/davinci-ecdx/data-source-server Create a new Task resource. Submit a Task resource representation in either JSON or XML format to create a new task in the system. The response includes the created resource with an ETag header for version tracking. ```APIDOC ## POST /Task ### Description Create a new Task resource. This endpoint accepts a FHIR Task resource and creates it in the system. ### Method POST ### Endpoint /Task ### Parameters #### Query Parameters - **format** (string) - Optional - The desired response format (application/fhir+json or application/fhir+xml) - **pretty** (boolean) - Optional - Pretty print the response - **summary** (string) - Optional - Summary mode for response - **elements** (string) - Optional - Elements to include in response ### Request Body - **Task** (object) - Required - A FHIR Task resource following the R4 specification ### Request Example { "resourceType": "Task", "id": "example", "status": "requested", "intent": "order" } ### Response #### Success Response (200) - **resourceType** (string) - Always 'Task' - **id** (string) - The unique identifier of the created resource - **meta** (object) - Metadata including version information - **ETag** (string) - Version from Resource.meta.version as a weak ETag (header) #### Response Example { "resourceType": "Task", "id": "12345", "meta": { "versionId": "1" }, "status": "requested", "intent": "order" } #### Error Response (default) - **resourceType** (string) - 'OperationOutcome' - **issue** (array) - Details about any errors encountered ``` -------------------------------- ### Python FHIR IG Validation Example Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Task-cdex-task-example7 This Python code snippet shows how to validate a FHIR Implementation Guide using the `fhir.resources` library. It loads the IG and performs validation against FHIR specifications. ```python from fhir.resources.implementationguide import ImplementationGuide from fhir.resources.resource import Resource # Load the IG from a JSON file with open("ig.json", "r") as f: ig_data = f.read() ig = ImplementationGuide(**json.loads(ig_data)) # Perform validation (example - actual validation logic would be more complex) print(f"Validating IG: {ig.name}") # Add validation checks here... ``` -------------------------------- ### POST /Subscription Source: https://build.fhir.org/ig/HL7/davinci-ecdx/cdex-capabilitystatement-inline-example Create a new Subscription resource. This endpoint allows you to create a new subscription instance by providing the complete resource state in the request body. The response returns the created resource with an ETag header for version tracking. ```APIDOC ## POST /Subscription ### Description Create a new Subscription resource. Allows clients to create a new subscription instance with the provided FHIR resource data. ### Method POST ### Endpoint /Subscription ### Request Body - **Subscription** (object) - Required - A complete FHIR Subscription resource in JSON format - Schema reference: https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Subscription ### Query Parameters - **summary** (string) - Optional - Request summary mode for response - **format** (string) - Optional - Response format (default: application/fhir+json) - **pretty** (boolean) - Optional - Pretty-print response JSON - **elements** (string) - Optional - Limit response to specified elements ### Request Example { "resourceType": "Subscription", "id": "example", "meta": { "versionId": "1" } } ### Response #### Success Response (200) - **Subscription** (object) - The created Subscription resource - **id** (string) - Resource identifier - **meta** (object) - Resource metadata including version - **ETag** (header) - Version from Resource.meta.version as a weak ETag #### Response Example { "resourceType": "Subscription", "id": "example-123", "meta": { "versionId": "1" } } #### Error Response (default) - **OperationOutcome** (object) - Error details and diagnostics - Schema reference: https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome ``` -------------------------------- ### Define FHIR Subscription Resource for CDex Task Scenario Source: https://build.fhir.org/ig/HL7/davinci-ecdx/ImplementationGuide-hl7.fhir.us Defines a Subscription resource example for the CDex task-based transaction scenario. This subscription is used in inline examples to demonstrate how subscription resources are requested and activated in clinical data exchange workflows. The example references the backport-subscription structure definition from the FHIR subscriptions-backport implementation guide. ```json { "extension": [{ "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Subscription" }], "reference": { "reference": "Subscription/cdex-task-inline-scenario1-subscription-requested" }, "name": "Inline Subscription Task Scenario1 Subscription Requested", "description": "Subscription example used to create inline scenarios for the example task based transaction using subscription", "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription", "groupingId": "InlineExamples" } ``` -------------------------------- ### POST /Encounter Source: https://build.fhir.org/ig/HL7/davinci-ecdx/cdex-capabilitystatement-inline-example Creates a new Encounter resource in the system. The request body must contain the complete Encounter resource data. Returns the newly created resource with assigned resource ID and version information. ```APIDOC ## POST /Encounter ### Description Create a new Encounter resource. The request body must contain the complete state of the new Encounter resource. ### Method POST ### Endpoint /Encounter #### Request Body - **Encounter** (FHIR Resource) - Required - The new Encounter resource to be created ### Request Example { "resourceType": "Encounter", "status": "finished", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "AMB" }, "subject": { "reference": "Patient/example" } } ### Response #### Success Response (200) - **Encounter** (FHIR Resource) - The resource after being created with assigned identifier - **ETag** (string) - Version from Resource.meta.version as a weak ETag #### Response Example { "resourceType": "Encounter", "id": "newly-created-id", "meta": { "versionId": "1" }, "status": "finished" } #### Error Response (default) - **OperationOutcome** (FHIR Resource) - Error details ``` -------------------------------- ### Display Private and Public Keys Source: https://build.fhir.org/ig/HL7/davinci-ecdx/signed-searchset-bundle-example This section demonstrates how to display the contents of the generated private and public key files using the 'cat' command. Note: Displaying private keys is for demonstration purposes only and should not be done in production environments. ```bash !cat private-key.pem !echo !cat public-key.pem ``` -------------------------------- ### FHIR Searchset Bundle Example (Turtle) Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Bundle-cdex-searchbundle-provenance-example An example of a FHIR Bundle with type 'searchset', containing Condition and Provenance resources. This bundle represents the results of a search query and includes information about the target resources and their provenance. ```turtle @prefix fhir: . @prefix xsd: . @prefix rdf: . @prefix sct: . a fhir:Bundle ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "cdex-searchbundle-provenance-example"] ; fhir:type [ fhir:v "searchset"] ; fhir:total [ fhir:v "1"^^xsd:nonNegativeInteger] ; fhir:link ( [ fhir:relation [ fhir:v "self" ] ; fhir:url [ fhir:v "http://hapi.fhir.org/baseR4/Condition?patient=06e1f0dd-5fbe-4480-9bb4-6b54ec02d31b&clinical-status=active,recurrance,remission&_revinclude=Provenance:target"^^xsd:anyURI ] ] ) ; fhir:entry ( [ fhir:fullUrl [ fhir:v "http://hapi.fhir.org/baseR4/Condition/4ac41715-fcbd-421c-8796-9b2c9706dd3f"^^xsd:anyURI ] ; fhir:resource ( ) ; fhir:search [ fhir:mode [ fhir:v "match" ] ] ] [ fhir:fullUrl [ fhir:v "http://hapi.fhir.org/baseR4/Provenance/b2ce4584-b213-411b-bdc9-d515dc92eadf"^^xsd:anyURI ] ; fhir:resource ( ) ; fhir:search [ fhir:mode [ fhir:v "include" ] ] ] ) . ``` -------------------------------- ### GET /metadata Source: https://build.fhir.org/ig/HL7/davinci-ecdx/cdex-capabilitystatement-inline-example Retrieves the server's Capability Statement, which describes the services and resources the server supports. ```APIDOC ## GET /metadata ### Description Returns the server's capability statement, which describes the services and resources the server supports according to the FHIR specification. ### Method GET ### Endpoint /metadata ### Parameters #### Query Parameters - **_format** (string) - Optional - The requested format for the response (e.g., application/fhir+json). - **_pretty** (boolean) - Optional - Indicates whether the response should be formatted for human readability. - **_summary** (string) - Optional - Controls the level of detail in the response (e.g., true, false, data, text, code, id, all). - **_elements** (string) - Optional - Specifies which elements to return in the response. ### Request Example ``` GET /metadata?_format=application/fhir+json ``` ### Response #### Success Response (200) - **CapabilityStatement** (object) - The server's capability statement describing supported features and resources. #### Response Example ```json { "resourceType": "CapabilityStatement", "url": "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/cdex-capabilitystatement-inline-example", "version": "2.1.0", "name": "CDEXCapabilityStatementInlineExample", "title": "R4 example of a CapabilityStatement advertising support for CDex Task Update topic-based subscription", "status": "active", "experimental": true, "date": "2021-10-20T00:00:00+00:00", "publisher": "HL7 International / Payer/Provider Information Exchange Work Group", "contact": [ { "name": "HL7 International / Payer/Provider Information Exchange Work Group", "telecom": [ { "system": "email", "value": "pie@lists.hl7.org" }, { "system": "url", "value": "http://www.hl7.org/Special/committees/claims" } ] } ], "description": "R4 example of a CapabilityStatement advertising support for CDex Task Update topic-based subscription", "license": "CC0-1.0", "kind": "instance", "fhirVersion": "4.0.1", "format": [ "json" ], "rest": [ { "mode": "server", "documentation": "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/cdex-capabilitystatement-inline-example", "resource": [ { "type": "Subscription", "interaction": [ { "code": "read" }, { "code": "update" } ] } ] } ] } ``` ``` -------------------------------- ### GET /fhir/Condition - Retrieve Patient Conditions Source: https://build.fhir.org/ig/HL7/davinci-ecdx/signed-searchset-bundle-example Retrieves condition resources for a specific patient. Returns a FHIR Bundle containing condition entries with clinical status, verification status, and encounter references. Supports filtering by patient identifier. ```APIDOC ## GET /fhir/Condition ### Description Retrieves condition resources associated with a specific patient. The response includes a searchset Bundle containing condition entries with coded diagnoses, clinical status, verification status, and related encounter information. ### Method GET ### Endpoint /fhir/Condition ### Parameters #### Query Parameters - **patient** (string) - Required - The patient identifier to filter conditions (e.g., "06e1f0dd-5fbe-4480-9bb4-6b54ec02d31b") ### Response #### Success Response (200) - **resourceType** (string) - Fixed value "Bundle" - **type** (string) - Bundle type ("searchset") - **total** (integer) - Total number of matching resources - **entry** (array) - Array of condition resources - **resource** (object) - FHIR Condition resource - **id** (string) - Unique condition identifier - **resourceType** (string) - Fixed value "Condition" - **meta** (object) - Metadata including versionId and lastUpdated - **clinicalStatus** (object) - Clinical status coding (e.g., "active") - **verificationStatus** (object) - Verification status coding (e.g., "confirmed") - **category** (array) - Condition category with coding (e.g., "encounter-diagnosis") - **code** (object) - ICD/SNOMED coded diagnosis - **coding** (array) - Array of coded values with system and code - **text** (string) - Display text for the condition - **subject** (object) - Reference to the Patient resource - **encounter** (object) - Reference to the related Encounter resource - **onsetDateTime** (string) - ISO 8601 timestamp when condition started - **recordedDate** (string) - ISO 8601 timestamp when condition was recorded - **text** (object) - Narrative HTML representation with div element - **link** (array) - Pagination and self-reference links - **relation** (string) - Link relationship type (e.g., "self") - **url** (string) - Full URL to the resource or query ### Request Example GET /fhir/Condition?patient=06e1f0dd-5fbe-4480-9bb4-6b54ec02d31b ### Response Example { "resourceType": "Bundle", "type": "searchset", "total": 1, "entry": [ { "fullUrl": "http://hapi.fhir.org/baseR4/Condition/4ac41715-fcbd-421c-8796-9b2c9706dd3f", "resource": { "resourceType": "Condition", "id": "4ac41715-fcbd-421c-8796-9b2c9706dd3f", "meta": { "versionId": "10", "lastUpdated": "2020-04-28T20:28:00.008+00:00" }, "text": { "status": "generated", "div": "
Hammer Toe
" }, "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed" } ] }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ] } ], "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "122481008", "display": "Hammer toe (disorder)" } ], "text": "Hammer Toe" }, "subject": { "reference": "http://example.org/cdex/provider/fhir/Patient/06e1f0dd-5fbe-4480-9bb4-6b54ec02d31b" }, "encounter": { "reference": "http://example.org/cdex/provider/fhir/Encounter/5fe62cd5-bfcf-4d3b-a1e9-80d6f75d6f82" }, "onsetDateTime": "2018-10-21T21:22:15-07:00", "recordedDate": "2018-10-21T21:22:15-07:00" }, "search": { "mode": "match" } } ], "link": [ { "relation": "self", "url": "http://hapi.fhir.org/baseR4/Condition?patient=06e1f0dd-5fbe-4480-9bb4-6b54ec02d31b" } ] } ### Signature Verification Responses may include JWS (JSON Web Signature) headers for cryptographic verification: - Extract the public key from the "x5c" (x509 certificate chain) header in the JWS - Base64 decode the certificate value - Verify the signature issuer and validity dates - Ensure the Signature.type.code elements match the "srCms" header ids - Validate that Signature.when matches the "Sigt" header timestamp ``` -------------------------------- ### Capability Statement Overview Source: https://build.fhir.org/ig/HL7/davinci-ecdx/CapabilityStatement-cdex-capabilitystatement-inline-example General capability statement information for the HL7 Da Vinci CDex implementation guide, version 2.1.0, published by HL7 International Payer/Provider Information Exchange Work Group. ```APIDOC ## Capability Statement: CDex Implementation Guide ### Overview - **Title**: HL7 FHIR Da Vinci Clinical Data Exchange (CDex) - **Version**: 2.1.0 - **Status**: active - **Published**: 2024-05-16 - **Jurisdiction**: United States (US) ### Publisher HL7 International / Payer/Provider Information Exchange Work Group ### Contact - **Website**: http://www.hl7.org/Special/committees/claims - **Email**: pie@lists.hl7.org ### Description R4 example of a CapabilityStatement advertising support for CDex Task Update topic-based subscription. ### Kind requirements ### Capability Statement URI http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/cdex-capabilitystatement-inline-example ### References - Backport Subscription Server R4 (1.1.0): http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server-r4|1.1.0 ### Copyright Used by permission of HL7 International all rights reserved Creative Commons License ``` -------------------------------- ### Subscription API Source: https://build.fhir.org/ig/HL7/davinci-ecdx/CapabilityStatement-data-source-server A server SHOULD support Subscription resources for task-based requests. It supports create, search-type, read, vread, and update interactions. ```APIDOC ## GET /Subscription/[id] ### Description Retrieves a specific Subscription resource by its ID. ### Method GET ### Endpoint `[base]/Subscription/[id]` ### Parameters #### Path Parameters - **id** (id) - Required - The logical ID of the Subscription resource to retrieve. ### Response #### Success Response (200) - **Subscription** (Subscription) - The requested Subscription resource. ``` -------------------------------- ### FHIR Task Resource (Turtle) Source: https://build.fhir.org/ig/HL7/davinci-ecdx/Task-cdex-task-inline-example22 This snippet represents a FHIR Task resource in Turtle format. It details a request for an attachment questionnaire, including patient information, requester, owner, reason codes, and input parameters. It's used within the HL7 Da Vinci CDEX implementation guide. ```turtle @prefix fhir: . @prefix xsd: . a fhir:Task ; fhir:nodeRole fhir:treeRoot ; fhir:contained ( [ a fhir:Patient ; fhir:id [ fhir:v "patient" ] ; fhir:identifier ( [ fhir:use [ fhir:v "usual" ] ; fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/v2-0203"^^xsd:anyURI ] ; fhir:code [ fhir:v "MB" ] ; fhir:display [ fhir:v "Member Number" ] ] ) ; fhir:text [ fhir:v "Member Number" ] ] ; fhir:system [ fhir:v "http://example.org/cdex/payer/member-ids"^^xsd:anyURI ] ; fhir:value [ fhir:v "Member123" ] ] [ fhir:use [ fhir:v "usual" ] ; fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType"^^xsd:anyURI ] ; fhir:code [ fhir:v "pat" ] ; fhir:display [ fhir:v "Patient Account Number" ] ] ) ; fhir:text [ fhir:v "Patient Account Number" ] ] ; fhir:system [ fhir:v "http://example.org/cdex/provider/patient-ids"^^xsd:anyURI ] ; fhir:value [ fhir:v "PA-123" ] ] ) ] ; fhir:name ( [ fhir:family [ fhir:v "Shaw" ] ; fhir:given ( [ fhir:v "Amy" ] ) ] ) fhir:birthDate [ fhir:v "1987-02-20"^^xsd:date ] ] [ a fhir:PractitionerRole ; fhir:id [ fhir:v "practitionerrole" ] ; fhir:practitioner [ fhir:identifier [ fhir:system [ fhir:v "http://hl7.org/fhir/sid/us-npi"^^xsd:anyURI ] ; fhir:value [ fhir:v "9941339100" ] ] ] ; fhir:organization [ fhir:identifier [ fhir:system [ fhir:v "http://hl7.org/fhir/sid/us-npi"^^xsd:anyURI ] ; fhir:value [ fhir:v "1234567893" ] ] ] ] ) ; fhir:identifier ( [ fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp"^^xsd:anyURI ] ; fhir:code [ fhir:v "tracking-id" ] ; fhir:display [ fhir:v "Tracking Id" ] ] ) fhir:text [ fhir:v "Re-Association Tracking Control Number" ] ] ; fhir:system [ fhir:v "http://example.org/payer"^^xsd:anyURI ] ; fhir:value [ fhir:v "trackingid1012" ] ] [ fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp"^^xsd:anyURI ] ; fhir:code [ fhir:v "admin-ref-number" ] ; fhir:display [ fhir:v "Administrative Reference Number" ] ] ) fhir:text [ fhir:v "Administrative Reference Number" ] ] ; fhir:system [ fhir:v "http://example.org/payer"^^xsd:anyURI ] ; fhir:value [ fhir:v "adminrefnumber4657" ] ] ) ; fhir:status [ fhir:v "requested"] ; fhir:intent [ fhir:v "order"] ; fhir:code [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/davinci-pas/CodeSystem/PASTempCodes"^^xsd:anyURI ] ; fhir:code [ fhir:v "attachment-request-questionnaire" ] ] ) fhir:text [ fhir:v "Attachment Request Questionnaire" ] ] ; fhir:for [ fhir:reference [ fhir:v "#patient" ] ] ; fhir:authoredOn [ fhir:v "2022-06-17T16:16:06Z"^^xsd:dateTime] ; fhir:lastModified [ fhir:v "2022-06-17T16:16:06Z"^^xsd:dateTime] ; fhir:requester [ fhir:identifier [ fhir:system [ fhir:v "http://example.org/cdex/payer/payer-ids"^^xsd:anyURI ] ; fhir:value [ fhir:v "Payer123" ] ] ] ; fhir:owner [ fhir:reference [ fhir:v "#practitionerrole" ] ] ; fhir:reasonCode [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/claim-use"^^xsd:anyURI ] ; fhir:code [ fhir:v "preauthorization" ] ; fhir:display [ fhir:v "Preauthorization" ] ] ) fhir:text [ fhir:v "preauthorization" ] ] ; fhir:reasonReference [ fhir:identifier [ fhir:system [ fhir:v "http://example.org/cdex/payer/claim-ids"^^xsd:anyURI ] ; fhir:value [ fhir:v "Preauth123" ] ] ] ; fhir:restriction [ fhir:period [ fhir:end [ fhir:v "2022-06-21"^^xsd:date ] ] ] ; fhir:input ( [ fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-paLineNumber"^^xsd:anyURI ] ; fhir:value [ a fhir:integer ; fhir:v 1 ] ] ) fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/davinci-pas/CodeSystem/PASTempCodes"^^xsd:anyURI ] ; fhir:code [ fhir:v "questionnaire-context" ] ] ) ] ; fhir:value [ a fhir:canonical ; fhir:v "http://example.org/cdex-questionnaire-example1"^^xsd:anyURI ; fhir:link ] ] [ fhir:type [ fhir:coding ( [ fhir:system [ fhir:v "http://hl7.org/fhir/us/davinci-pas/CodeSystem/PASTempCodes"^^xsd:anyURI ] ; fhir:code [ fhir:v "questionnaire-context" ] ] ) ] ] ) . ```