Home
How to use Redox
Interact with clinical networks
Onramp to Carequality
Create an organization record with FHIR®

Create an organization record with FHIR

Last updated: May 1, 2026
IMPLEMENTATION
Who can use this how-to
  • Existing customers using Network Onramps to connect to the Carequality Interoperability Framework.
  • Existing customers with a direct connection to the Carequality Interoperability Framework (i.e., without Redox).

An organization record (i.e., OID within the Redox organization or your own OID) is the unique identifier for your organization within the Carequality Interoperability Framework. The organization OID is how you identify yourself when searching for patients—and how other Carequality participants can find you and your patients.

You should plan to register at least one Carequality organization record per unique master patient index (MPI) or physical location. Learn more about OIDs and identity to understand why you may want to register more than one organization.

Data model option

Did you know you can also do this workflow with Redox data models? Learn how to create an organization record with the Redox Data Model API.

Use curl for technical validation

You can copy our code examples and send the test requests with curl (learn more about curl) instead of Postman. If you do, remember to:

  • Replace any variables with your specific data (e.g., your organization's OID) before sending the request.
    • $VARIABLE: An environment variable you can set in your terminal before running the command.
    • {{variable here}}: A placeholder for your specific data.
  • Add the source-id if you have multiple sources. We don’t include {{source-id}} in the code examples, so you’ll have to add them yourself. Learn about including source details.
  • Make sure you have a full request for your own use since some of the code examples are abbreviated.

Check out these troubleshooting guides if you run into errors:

FHIR® destination slugs

You must populate any test queries with the appropriate FHIR® destination slug for the specific type of request:

Query purposeDestination slug
Query for/create/update/delete an organizationceq-orgs
Perform a patient search within a specific organizationceq-xcpd:{{OID-FROM-ORGANIZATION-QUERY}}
Search for a clinical summary/documentceq-xca:{{OID-FROM-ORGANIZATION-QUERY}}
Which OID to use

The {{OID-FROM-ORGANIZATION-QUERY}} is the OID of the Carequality participant you’re querying, not the OID of your Carequality organization.

Create your organization record

  1. In your development environment, using Postman or curl, send an Organization create request to create your organization record in Carequality. The id property should match the OID provided in the identifier array and is required.
    FHIR example: Create an organization record
    bash
    1
    curl --request POST \
    2
      --url https://api.redoxengine.com/fhir/R4/ceq-orgs/{{ENVIRONMENT}}/Organization \
    3
      --header 'Content-Type: application/json' \
    4
      --data '{
    5
      "resourceType": "Organization",
    6
      "id": "2.16.840.1.113883.3.6147.458.2",
    7
      "identifier": [
    8
        {
    9
          "use": "official",
    10
          "system": "http://www.hl7.org/oid/",
    11
          "value": "2.16.840.1.113883.3.6147.458.2"
    12
        }
    13
      ],
    14
      "active": true,
    15
      "type": [
    16
        {
    17
          "coding": [
    18
            {
    19
              "system": "http://hl7.org/fhir/organization-type",
    20
              "code": "Connection"
    21
            }
    22
          ]
    23
        }
    24
      ],
    25
      "name": "Redox Gateway",
    26
      "alias": [
    27
        "Redox"
    28
      ],
    29
      "address": [
    30
        {
    31
          "use": "work",
    32
          "type": "both",
    33
          "line": [
    34
            "25 West Main Street, Suite 500"
    35
          ],
    36
          "city": "Madison",
    37
          "state": "WI",
    38
          "postalCode": "53703",
    39
          "country": "USA"
    40
        }
    41
      ],
    42
      "partOf": {
    43
        "identifier": {
    44
          "use": "official",
    45
          "system": "http://www.hl7.org/oid/",
    46
          "type": {
    47
            "text": "HCID"
    48
          },
    49
          "value": "2.16.840.1.113883.3.6147.458"
    50
        }
    51
      },
    52
      "contact": [
    53
        {
    54
          "purpose": {
    55
            "text": "Technical"
    56
          },
    57
          "name": {
    58
            "use": "official",
    59
            "text": "Redox, Carequality"
    60
          },
    61
          "telecom": [
    62
            {
    63
              "system": "email",
    64
              "value": "carequality@redoxengine.com",
    65
              "use": "work"
    66
            },
    67
            {
    68
              "system": "phone",
    69
              "value": "+16085359501",
    70
              "use": "work"
    71
            }
    72
          ]
    73
        },
    74
        {
    75
          "purpose": {
    76
            "text": "Business"
    77
          },
    78
          "name": {
    79
            "use": "official",
    80
            "text": "Redox, Carequality"
    81
          },
    82
          "telecom": [
    83
            {
    84
              "system": "email",
    85
              "value": "support@redoxengine.com",
    86
              "use": "work"
    87
            },
    88
            {
    89
              "system": "phone",
    90
              "value": "+16085359501",
    91
              "use": "work"
    92
            }
    93
          ]
    94
        }
    95
      ]
    96
    }
    API reference

    Review the Organization schema for more technical details.

  2. If the request is successful, you receive a synchronous response indicating that your organization record was created.
    FHIR Example: Successful response for creating an organization record
    json
    1
    200 OK
  3. Once you complete testing, repeat these steps for your production environment.

If you don’t receive the expected response, review common Carequality errors.

Update your organization record

Whenever there are changes to your organization details (e.g., address or contact information), follow these steps to keep your organization record up-to-date:

  1. Send an Organization update request with the updated organization details.
    FHIR example: Update an organization record
    bash
    1
    curl --request PUT \
    2
      --url https://api.redoxengine.com/fhir/R4/ceq-orgs/{{ENVIRONMENT}}/Organization/2.16.840.1.113883.3.6147.458.2 \
    3
      --header 'Content-Type: application/json' \
    4
      --data '{
    5
      "resourceType": "Organization",
    6
      "id": "2.16.840.1.113883.3.6147.458.2",
    7
      "identifier": [
    8
        {
    9
          "use": "official",
    10
          "system": "http://www.hl7.org/oid/",
    11
          "value": "2.16.840.1.113883.3.6147.458.2"
    12
        }
    13
      ],
    14
      "active": true,
    15
      "type": [
    16
        {
    17
          "coding": [
    18
            {
    19
              "system": "http://hl7.org/fhir/organization-type",
    20
              "code": "Connection"
    21
            }
    22
          ]
    23
        }
    24
      ],
    25
      "name": "Redox Gateway",
    26
      "alias": [
    27
        "Redox"
    28
      ],
    29
      "address": [
    30
        {
    31
          "use": "work",
    32
          "type": "both",
    33
          "line": [
    34
            "25 West Main Street, Suite 500"
    35
          ],
    36
          "city": "Madison",
    37
          "state": "WI",
    38
          "postalCode": "53703",
    39
          "country": "USA"
    40
        }
    41
      ],
    42
      "partOf": {
    43
        "identifier": {
    44
          "use": "official",
    45
          "system": "http://www.hl7.org/oid/",
    46
          "type": {
    47
            "text": "HCID"
    48
          },
    49
          "value": "2.16.840.1.113883.3.6147.458"
    50
        }
    51
      },
    52
      "contact": [
    53
        {
    54
          "purpose": {
    55
            "text": "Technical"
    56
          },
    57
          "name": {
    58
            "use": "official",
    59
            "text": "Redox, Carequality"
    60
          },
    61
          "telecom": [
    62
            {
    63
              "system": "email",
    64
              "value": "carequality@redoxengine.com",
    65
              "use": "work"
    66
            },
    67
            {
    68
              "system": "phone",
    69
              "value": "+16085359501",
    70
              "use": "work"
    71
            }
    72
          ]
    73
        },
    74
        {
    75
          "purpose": {
    76
            "text": "Business"
    77
          },
    78
          "name": {
    79
            "use": "official",
    80
            "text": "Redox, Carequality"
    81
          },
    82
          "telecom": [
    83
            {
    84
              "system": "email",
    85
              "value": "support@redoxengine.com",
    86
              "use": "work"
    87
            },
    88
            {
    89
              "system": "phone",
    90
              "value": "+16085359501",
    91
              "use": "work"
    92
            }
    93
          ]
    94
        }
    95
      ]
    96
    }
    API reference

    Review the Organization update schema for more technical details.

  2. If the request is successful, you receive a synchronous response indicating that your organization record was updated.
    FHIR example: Successful response for updating an organization record
    json
    1
    200 OK

Deactivate your organization record

Whenever there are changes to your organization details (e.g., address or contact information), follow these steps to keep your organization record up-to-date:

  1. Send an Organization update request with the Active field set to false to deactivate the organization record.
    What deactivating means

    Marking an organization as inactive doesn’t erase all of its information or delete the organization record. It simply notes the facility as inactive.

    FHIR example: Deactivate an organization record
    bash
    1
    curl --request PUT \
    2
      --url https://api.redoxengine.com/fhir/R4/ceq-orgs/{{ENVIRONMENT}}/Organization/2.16.840.1.113883.3.6147.458.2 \
    3
      --header 'Content-Type: application/json' \
    4
      --data '{
    5
      "resourceType": "Organization",
    6
      "id": "2.16.840.1.113883.3.6147.458.2",
    7
      "identifier": [
    8
        {
    9
          "use": "official",
    10
          "system": "http://www.hl7.org/oid/",
    11
          "value": "2.16.840.1.113883.3.6147.458.2"
    12
        }
    13
      ],
    14
      "active": false,
    15
      "type": [
    16
        {
    17
          "coding": [
    18
            {
    19
              "system": "http://hl7.org/fhir/organization-type",
    20
              "code": "Connection"
    21
            }
    22
          ]
    23
        }
    24
      ],
    25
      "name": "Redox Gateway",
    26
      "alias": [
    27
        "Redox"
    28
      ],
    29
      "address": [
    30
        {
    31
          "use": "work",
    32
          "type": "both",
    33
          "line": [
    34
            "25 West Main Street, Suite 500"
    35
          ],
    36
          "city": "Madison",
    37
          "state": "WI",
    38
          "postalCode": "53703",
    39
          "country": "USA"
    40
        }
    41
      ],
    42
      "partOf": {
    43
        "identifier": {
    44
          "use": "official",
    45
          "system": "http://www.hl7.org/oid/",
    46
          "type": {
    47
            "text": "HCID"
    48
          },
    49
          "value": "2.16.840.1.113883.3.6147.458"
    50
        }
    51
      },
    52
      "contact": [
    53
        {
    54
          "purpose": {
    55
            "text": "Technical"
    56
          },
    57
          "name": {
    58
            "use": "official",
    59
            "text": "Redox, Carequality"
    60
          },
    61
          "telecom": [
    62
            {
    63
              "system": "email",
    64
              "value": "carequality@redoxengine.com",
    65
              "use": "work"
    66
            },
    67
            {
    68
              "system": "phone",
    69
              "value": "+16085359501",
    70
              "use": "work"
    71
            }
    72
          ]
    73
        },
    74
        {
    75
          "purpose": {
    76
            "text": "Business"
    77
          },
    78
          "name": {
    79
            "use": "official",
    80
            "text": "Redox, Carequality"
    81
          },
    82
          "telecom": [
    83
            {
    84
              "system": "email",
    85
              "value": "support@redoxengine.com",
    86
              "use": "work"
    87
            },
    88
            {
    89
              "system": "phone",
    90
              "value": "+16085359501",
    91
              "use": "work"
    92
            }
    93
          ]
    94
        }
    95
      ]
    96
    }
    API reference

    Review the Organization update schema for more technical details.

  2. If the request is successful, you receive a synchronous response indicating that your organization record was updated.
    FHIR example: Successful response for deactivating an organization record
    json
    1
    200 OK

Next steps

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.