Commure FHIR API

# generated: 2026-07-31
# method: derived
# source: https://www.postman.com/collections/8745312-3d47dab4-e5ff-4e53-85fd-e53659614b24
openapi: 3.1.0
info:
  title: Commure FHIR API
  version: v1
  summary: HL7 FHIR REST API and SMART App Launch / OpenID Connect authentication surface of the Commure
    Developer Platform.
  description: 'Derived verbatim from Commure''s first-party PUBLIC Postman collection "Commure FHIR API"
    (https://www.postman.com/commure/commure/collection/8745312-3d47dab4-e5ff-4e53-85fd-e53659614b24).
    The majority of endpoints are specified by the HL7 FHIR standard for healthcare data exchange; Commure
    adds extended operations ($commure-json-patch, $bulk-delete, $async-status, $async-cancel) alongside
    the standard FHIR RESTful, terminology, and Bulk Data operations.


    NOTE ON AVAILABILITY: the Commure Developer Platform this contract describes (developer.commure.com,
    tenant hosts api-{tenant-id}.developer.commure.com) no longer resolves publicly (HTTP 404 / NXDOMAIN
    as of 2026-07-31). This document is captured as the machine-readable record of a real, published contract
    - it is not a claim that the endpoints are currently callable.'
  contact:
    name: Commure Developer Support
    email: dev-support@commure.com
  x-origin:
  - format: postman
    version: 2.1.0
    url: https://www.postman.com/collections/8745312-3d47dab4-e5ff-4e53-85fd-e53659614b24
    converter: api-evangelist enrichment pipeline (postman->openapi)
servers:
- url: https://api-{tenant-id}.developer.commure.com
  description: Tenant-scoped Commure Developer Platform host (per Commure's published Postman collection).
    Currently non-resolving.
  variables:
    tenant-id:
      default: tenant-id
      description: Tenant identifier, the suffix on the dashboard URL when signed in to the Commure Developer
        Platform.
tags:
- name: FHIR
- name: auth
paths:
  /api/v1/{fhir_version}/{type}/{id}/_history:
    get:
      operationId: getVersionHistoryResource
      summary: Get the version history of a resource
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) The version of the FHIR specification that this CapabilityStatement describes
          (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no
          default value.
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) the Logical Id of a resource
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/{type}/{id}/_history/{vid}:
    get:
      operationId: getSpecificVersionResource
      summary: Get a specific version of a resource
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) The version of the FHIR specification that this CapabilityStatement describes
          (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no
          default value.
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) the Logical Id of a resource
        schema:
          type: string
      - name: vid
        in: path
        required: true
        description: (Required) the Version Id of a resource
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '404':
          description: Not Found
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '410':
          description: Gone
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/{type}/{id}:
    get:
      operationId: getResource
      summary: Get a resource
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) The version of the FHIR specification that this CapabilityStatement describes
          (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no
          default value.
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) the Logical Id of a resource
        schema:
          type: string
      - name: Etag
        in: header
        required: false
        description: header containing the Version Id of a resource (e.g. W/'23')
        schema:
          type: string
      - name: If-Modified-Since
        in: header
        required: false
        description: header indicating a conditional read, if used client SHALL accept a 304 Not Modified
          response
        schema:
          type: string
      - name: If-None-Match
        in: header
        required: false
        description: header indicating a conditional read, if used client SHALL accept a 304 Not Modified
          response
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '304':
          description: Not Modified
          content:
            application/fhir+json:
              schema:
                type: object
        '404':
          description: Not Found
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '410':
          description: Gone
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
    put:
      operationId: updateResource
      summary: Update a resource
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) The version of the FHIR specification that this CapabilityStatement describes
          (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no
          default value.
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) the Logical Id of a resource
        schema:
          type: string
      - name: If-Match
        in: header
        required: false
        description: header indicating a conditional read, if used client SHALL accept a 304 Not Modified
          response
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
              description: FHIR resource or Parameters resource
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '201':
          description: Created
          content:
            application/fhir+json:
              schema:
                type: object
        '304':
          description: Not Modified
          content:
            application/fhir+json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '401':
          description: Unauthorized
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '404':
          description: Not Found
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '405':
          description: Method Not Allowed
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '409':
          description: Conflict
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '412':
          description: Precondition Failed
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '422':
          description: Unprocessable Entity
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
    delete:
      operationId: deleteResource
      summary: Delete a resource
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) The version of the FHIR specification that this CapabilityStatement describes
          (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no
          default value.
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) the Logical Id of a resource
        schema:
          type: string
      - name: search parameters
        in: query
        required: false
        description: optional search parameters for conditional delete
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '204':
          description: No Content
          content:
            application/fhir+json:
              schema:
                type: object
        '405':
          description: Method Not Allowed
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '409':
          description: Conflict
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '412':
          description: Precondition Failed
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/{type}/{id}/$fhir-patch:
    post:
      operationId: applyFHIRPatchSTU3Resources
      summary: Apply FHIRPatch for STU3 resources
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) Version of the FHIR
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) id of the instance
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
              description: FHIR resource or Parameters resource
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '500':
          description: Internal Server Error
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/{type}/{id}/$commure-json-patch:
    post:
      operationId: applyJSONPatchAsExtendedOperation
      summary: Apply JSON patch as extended operation
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) Version of the FHIR
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) id of the instance
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      - name: patch
        in: query
        required: false
        description: (Required) JSON Patch to apply, serialized as string
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '500':
          description: Internal Server Error
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/{type}/{id}/$validate:
    post:
      operationId: validateResource
      summary: Validate a resource
      description: "The validate operation checks whether the attached content would be acceptable either\
        \ generally, as a create, an update or as a delete to an existing resource.  The action the server\
        \ takes depends on the mode parameter:  \n\n* [mode not provided]: The server checks the content\
        \ of the resource against any schema, constraint rules, and other general terminology rules \n\
        * create: The server checks the content, and then checks that the content would be acceptable\
        \ as a create (e.g. that the content would not violate any uniqueness constraints) \n* update:\
        \ The server checks the content, and then checks that it would accept it as an update against\
        \ the nominated specific resource (e.g. that there are no changes to immutable fields the server\
        \ does not allow to change, and checking version integrity if appropriate) \n* delete: The server\
        \ ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking\
        \ referential integrity rules)  \n\nModes update and delete can only be used when the operation\
        \ is invoked at the resource instance level.   The return from this operation is an [OperationOutcome](https://www.hl7.org/fhir/operationoutcome.html)\n\
        \nNote that this operation is not the only way to validate resources - see [Validating Resources](https://www.hl7.org/fhir/validation.html)\
        \ for further information."
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) Version of the FHIR
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) id of the instance
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
              description: FHIR resource or Parameters resource
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '500':
          description: Internal Server Error
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/{type}:
    get:
      operationId: searchResourcesType
      summary: Search resources of a type
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) The version of the FHIR specification that this CapabilityStatement describes
          (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no
          default value.
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      - name: parameters
        in: query
        required: false
        description: search criteria
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '401':
          description: Unauthorized
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '404':
          description: Not Found
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
    post:
      operationId: createResource
      summary: Create a resource
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) The version of the FHIR specification that this CapabilityStatement describes
          (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no
          default value.
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      - name: If-None-Exist
        in: header
        required: false
        description: create a new resource only if some equivalent resource does not already exist on
          the server. The client defines what equivalence means in this case by supplying a FHIR search
          query in the header
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
              description: FHIR resource or Parameters resource
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '201':
          description: Created
          content:
            application/fhir+json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '404':
          description: Not Found
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '412':
          description: Precondition Failed
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '422':
          description: Unprocessable Entity
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/{type}/_history:
    get:
      operationId: getVersionHistoryAllResourcesType
      summary: Get the version history of all resources of a type
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) The version of the FHIR specification that this CapabilityStatement describes
          (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no
          default value.
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/{type}/$validate:
    post:
      operationId: validateResource2
      summary: Validate a resource
      description: "The validate operation checks whether the attached content would be acceptable either\
        \ generally, as a create, an update or as a delete to an existing resource.  The action the server\
        \ takes depends on the mode parameter:  \n\n* [mode not provided]: The server checks the content\
        \ of the resource against any schema, constraint rules, and other general terminology rules \n\
        * create: The server checks the content, and then checks that the content would be acceptable\
        \ as a create (e.g. that the content would not violate any uniqueness constraints) \n* update:\
        \ The server checks the content, and then checks that it would accept it as an update against\
        \ the nominated specific resource (e.g. that there are no changes to immutable fields the server\
        \ does not allow to change, and checking version integrity if appropriate) \n* delete: The server\
        \ ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking\
        \ referential integrity rules)  \n\nModes update and delete can only be used when the operation\
        \ is invoked at the resource instance level.   The return from this operation is an [OperationOutcome](https://www.hl7.org/fhir/operationoutcome.html)\n\
        \nNote that this operation is not the only way to validate resources - see [Validating Resources](https://www.hl7.org/fhir/validation.html)\
        \ for further information."
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) Version of the FHIR
        schema:
          type: string
      - name: type
        in: path
        required: true
        description: (Required) the name of a resource type (e.g. 'Patient')
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
              description: FHIR resource or Parameters resource
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '500':
          description: Internal Server Error
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/CodeSystem/{id}/$validate-code:
    post:
      operationId: codeSystemBasedValidation
      summary: Code System based Validation
      description: 'Validate that a coded value is in the code system. If the operation is not called
        at the instance level, one of the parameters "url" or "codeSystem" must be provided. The operation
        returns a result (true / false), an error message, and the recommended display for the code.


        When invoking this operation, a client SHALL provide one (and only one) of the parameters (code+system,
        coding, or codeableConcept). Other parameters (including version and display) are optional'
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) Version of the FHIR
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) id of the instance
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
              description: FHIR resource or Parameters resource
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '404':
          description: Not Found
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '500':
          description: Internal Server Error
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/CodeSystem/{id}/$subsumes:
    post:
      operationId: subsumptionTesting
      summary: Subsumption Testing
      description: 'Test the subsumption relationship between code/Coding A and code/Coding B given the
        semantics of subsumption in the underlying code system (see [hierarchyMeaning](https://www.hl7.org/fhir/codesystem-definitions.html#CodeSystem.hierarchyMeaning)).


        When invoking this operation, a client SHALL provide both a and codes, either as code or Coding
        parameters. The system parameter is required unless the operation is invoked on an instance of
        a code system resource. Other parameters are optional'
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) Version of the FHIR
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: (Required) id of the instance
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
              description: FHIR resource or Parameters resource
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '404':
          description: Not Found
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '500':
          description: Internal Server Error
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/CodeSystem/$validate-code:
    post:
      operationId: codeSystemBasedValidation2
      summary: Code System based Validation
      description: 'Validate that a coded value is in the code system. If the operation is not called
        at the instance level, one of the parameters "url" or "codeSystem" must be provided. The operation
        returns a result (true / false), an error message, and the recommended display for the code.


        When invoking this operation, a client SHALL provide one (and only one) of the parameters (code+system,
        coding, or codeableConcept). Other parameters (including version and display) are optional'
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) Version of the FHIR
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
              description: FHIR resource or Parameters resource
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '404':
          description: Not Found
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '500':
          description: Internal Server Error
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_version}/CodeSystem/$lookup:
    post:
      operationId: conceptLookUpDecomposition
      summary: Concept Look Up & Decomposition
      description: 'Given a code/system, or a Coding, get additional details about the concept, including
        definition, status, designations, and properties. One of the products of this operation is a full
        decomposition of a code from a structured terminology.


        When invoking this operation, a client SHALL provide both a system and a code, either using the
        system+code parameters, or in the coding parameter. Other parameters are optional'
      tags:
      - FHIR
      parameters:
      - name: fhir_version
        in: path
        required: true
        description: (Required) Version of the FHIR
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              type: object
              description: FHIR resource or Parameters resource
      responses:
        '200':
          description: OK
          content:
            application/fhir+json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '404':
          description: Not Found
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '500':
          description: Internal Server Error
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      security:
      - SMARTonFHIR: []
      - bearerAuth: []
  /api/v1/{fhir_ve

# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/commure/refs/heads/main/openapi/commure-fhir-openapi.yml