Find potential clinical trials

POST

/v1/fhir/patient/matches

This endpoint processes a bundle of patient data and finds potential clinical trial matches based on the submitted information. The results are returned in the specified format (JSON or XML) to the provided callback URL

Request

Authorization

Add parameter in header

Example:

X-Token: ********************

Body Params application/json

resourceType

string

required

type

string

required

entry

array [object {1}]

required

resource

object

required

extension

array [object {2}]

required

url

string

optional

valueUrl

string

optional

Example

{
  "resourceType": "Bundle",
  "type": "collection",
  "entry": [
    {
      "resource": {
        "resourceType": "Bundle",
        "type": "collection",
        "entry": [
          {
            "fullUrl": "urn:uuid:patient1",
            "resource": {
              "resourceType": "Patient",
              "id": "patient1",
              "identifier": [
                {
                  "system": "http://example.org/fhir/patient",
                  "value": "12345"
                }
              ],
              "name": [
                {
                  "family": "Doe",
                  "given": [
                    "John"
                  ]
                }
              ],
              "birthDate": "1970-01-01",
              "gender": "male"
            }
          },
          {
            "fullUrl": "urn:uuid:obs1",
            "resource": {
              "resourceType": "Observation",
              "id": "obs1",
              "status": "final",
              "code": {
                "coding": [
                  {
                    "system": "http://loinc.org",
                    "code": "29463-7",
                    "display": "Body weight"
                  }
                ],
                "text": "Body weight"
              },
              "subject": {
                "reference": "Patient/patient1"
              },
              "effectiveDateTime": "2024-06-13T12:00:00Z",
              "valueQuantity": {
                "value": 68,
                "unit": "kg",
                "system": "http://unitsofmeasure.org",
                "code": "kg"
              }
            }
          },
          {
            "fullUrl": "urn:uuid:cond1",
            "resource": {
              "resourceType": "Condition",
              "id": "cond1",
              "code": {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "254637007",
                    "display": "Malignant tumor of breast"
                  }
                ],
                "text": "Breast Cancer"
              },
              "subject": {
                "reference": "Patient/patient1"
              },
              "verificationStatus": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                    "code": "confirmed",
                    "display": "Confirmed"
                  }
                ]
              }
            }
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Bundle",
        "type": "collection",
        "entry": [
          {
            "fullUrl": "urn:uuid:patient2",
            "resource": {
              "resourceType": "Patient",
              "id": "patient2",
              "identifier": [
                {
                  "system": "http://example.org/fhir/patient",
                  "value": "67890"
                }
              ],
              "name": [
                {
                  "family": "Smith",
                  "given": [
                    "Jane"
                  ]
                }
              ],
              "birthDate": "1980-05-15",
              "gender": "female"
            }
          },
          {
            "fullUrl": "urn:uuid:obs2",
            "resource": {
              "resourceType": "Observation",
              "id": "obs2",
              "status": "final",
              "code": {
                "coding": [
                  {
                    "system": "http://loinc.org",
                    "code": "8302-2",
                    "display": "Body height"
                  }
                ],
                "text": "Body height"
              },
              "subject": {
                "reference": "Patient/patient2"
              },
              "effectiveDateTime": "2024-06-13T12:00:00Z",
              "valueQuantity": {
                "value": 160,
                "unit": "cm",
                "system": "http://unitsofmeasure.org",
                "code": "cm"
              }
            }
          },
          {
            "fullUrl": "urn:uuid:cond2",
            "resource": {
              "resourceType": "Condition",
              "id": "cond2",
              "code": {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "44054006",
                    "display": "Diabetes mellitus type 2"
                  }
                ],
                "text": "Diabetes mellitus type 2"
              },
              "subject": {
                "reference": "Patient/patient2"
              },
              "verificationStatus": {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                    "code": "confirmed",
                    "display": "Confirmed"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "extension": [
    {
      "url": "https://bowheadhealth.com/fhir/extensions/callbackurl",
      "valueUrl": "{{callback_url}}"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/fhir/patient/matches' \
--header 'Content-Type: application/json' \
--data-raw '{
    "resourceType": "Bundle",
    "type": "collection",
    "entry": [
        {
            "resource": {
                "resourceType": "Bundle",
                "type": "collection",
                "entry": [
                    {
                        "fullUrl": "urn:uuid:patient1",
                        "resource": {
                            "resourceType": "Patient",
                            "id": "patient1",
                            "identifier": [
                                {
                                    "system": "http://example.org/fhir/patient",
                                    "value": "12345"
                                }
                            ],
                            "name": [
                                {
                                    "family": "Doe",
                                    "given": [
                                        "John"
                                    ]
                                }
                            ],
                            "birthDate": "1970-01-01",
                            "gender": "male"
                        }
                    },
                    {
                        "fullUrl": "urn:uuid:obs1",
                        "resource": {
                            "resourceType": "Observation",
                            "id": "obs1",
                            "status": "final",
                            "code": {
                                "coding": [
                                    {
                                        "system": "http://loinc.org",
                                        "code": "29463-7",
                                        "display": "Body weight"
                                    }
                                ],
                                "text": "Body weight"
                            },
                            "subject": {
                                "reference": "Patient/patient1"
                            },
                            "effectiveDateTime": "2024-06-13T12:00:00Z",
                            "valueQuantity": {
                                "value": 68,
                                "unit": "kg",
                                "system": "http://unitsofmeasure.org",
                                "code": "kg"
                            }
                        }
                    },
                    {
                        "fullUrl": "urn:uuid:cond1",
                        "resource": {
                            "resourceType": "Condition",
                            "id": "cond1",
                            "code": {
                                "coding": [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "254637007",
                                        "display": "Malignant tumor of breast"
                                    }
                                ],
                                "text": "Breast Cancer"
                            },
                            "subject": {
                                "reference": "Patient/patient1"
                            },
                            "verificationStatus": {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                                        "code": "confirmed",
                                        "display": "Confirmed"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        },
        {
            "resource": {
                "resourceType": "Bundle",
                "type": "collection",
                "entry": [
                    {
                        "fullUrl": "urn:uuid:patient2",
                        "resource": {
                            "resourceType": "Patient",
                            "id": "patient2",
                            "identifier": [
                                {
                                    "system": "http://example.org/fhir/patient",
                                    "value": "67890"
                                }
                            ],
                            "name": [
                                {
                                    "family": "Smith",
                                    "given": [
                                        "Jane"
                                    ]
                                }
                            ],
                            "birthDate": "1980-05-15",
                            "gender": "female"
                        }
                    },
                    {
                        "fullUrl": "urn:uuid:obs2",
                        "resource": {
                            "resourceType": "Observation",
                            "id": "obs2",
                            "status": "final",
                            "code": {
                                "coding": [
                                    {
                                        "system": "http://loinc.org",
                                        "code": "8302-2",
                                        "display": "Body height"
                                    }
                                ],
                                "text": "Body height"
                            },
                            "subject": {
                                "reference": "Patient/patient2"
                            },
                            "effectiveDateTime": "2024-06-13T12:00:00Z",
                            "valueQuantity": {
                                "value": 160,
                                "unit": "cm",
                                "system": "http://unitsofmeasure.org",
                                "code": "cm"
                            }
                        }
                    },
                    {
                        "fullUrl": "urn:uuid:cond2",
                        "resource": {
                            "resourceType": "Condition",
                            "id": "cond2",
                            "code": {
                                "coding": [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "44054006",
                                        "display": "Diabetes mellitus type 2"
                                    }
                                ],
                                "text": "Diabetes mellitus type 2"
                            },
                            "subject": {
                                "reference": "Patient/patient2"
                            },
                            "verificationStatus": {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                                        "code": "confirmed",
                                        "display": "Confirmed"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ],
    "extension": [
        {
            "url": "https://bowheadhealth.com/fhir/extensions/callbackurl",
            "valueUrl": "{{callback_url}}"
        }
    ]
}'

Responses

🟢202Accepted

application/xml

Body

object {0}

Example

<?xml version="1.0" encoding="UTF-8"?>
<root/>

🟢202Accepted

🟠4004XX. JSON

🟠4004XX. XML

🟠401Unauthorized

🔴500500. JSON

🔴500500. XML

Modified at 2024-07-05 17:25:40

Find guidelines

Callback url