Predoc · Schema

CreatePatientWithCrrV2InpDto

CompanyHealthcareMedical RecordsHealth Information ExchangeFHIRClinical DataArtificial IntelligenceInteroperabilityEHR IntegrationWebhookClinical Research

Properties

Name	Type	Description
releaseToOrgName	string	Name of the organization making the request.
releaseToProviderName	string	Name of the provider the patient is being released to.
previousProviders	array	List of previous providers known for the requested patient.
doNotKnowPreviousProvider	boolean	NOTE: This field is deprecated and will be removed in a future release. Please use the `previousProviders` field instead.
reasonForRequest	integer	Reason for the request: `0` for Future Appointment or `2` for Information Gathering.
futureAppointmentDate	string	Date of the future appointment in `YYYY-MM-DD` format. Required if the request reason is `0 (Future Appointment)`.
requestingProviderEmail	string	Email address of the provider or physician making the request.
patientAuthFile	object	Base-64 encoded file data for the patient authorization file, if available.
referenceId	string	User-defined reference number for the request. This can be used for your own records and is not used by the Predoc platform.
sendHieRequest	boolean	Send HIE request.
sendMedicationsRequest	boolean	Send Medications request.
facesheetConfigId	string	Facesheet config ID to generate request with.
facesheetConfigIds	array	Facesheet config IDs to generate request with.
firstName	string	First name of the patient.
middleInitial	string	Middle initial of the patient.
lastName	string	Last name of the patient.
dateOfBirth	string	Date of birth of the patient, in `YYYY-MM-DD` format.
phoneCountryCode	string	Country code of the patient's phone number with a `+` at the beginning. Defaults to +1.
phoneNumber	string	Phone number of the patient, with no special characters (only digits).
email	string	Email address of the patient.
patientAddress	object	Physical address of the patient.
patientGender	string	Gender of the patient.
allowDuplicatePatient	boolean	Override the patient demographics check and create the patient regardless of whether a patient with the same PII exists.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/predoc/main/json-schema/predoc-create-patient-with-crr-v2-inp-dto-schema.json",
  "title": "CreatePatientWithCrrV2InpDto",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/predoc-partner-api-openapi.yml#/components/schemas/CreatePatientWithCrrV2InpDto",
  "type": "object",
  "properties": {
    "releaseToOrgName": {
      "type": "string",
      "description": "Name of the organization making the request."
    },
    "releaseToProviderName": {
      "type": "string",
      "description": "Name of the provider the patient is being released to."
    },
    "previousProviders": {
      "description": "List of previous providers known for the requested patient.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/PreviousProviderInpDto"
      }
    },
    "doNotKnowPreviousProvider": {
      "type": "boolean",
      "deprecated": true,
      "description": "<strong>NOTE:</strong> This field is deprecated and will be removed in a future release. Please use the `previousProviders` field instead."
    },
    "reasonForRequest": {
      "type": "integer",
      "description": "Reason for the request: `0` for Future Appointment or `2` for Information Gathering.",
      "enum": [
        0,
        2
      ]
    },
    "futureAppointmentDate": {
      "type": "string",
      "description": "Date of the future appointment in `YYYY-MM-DD` format. Required if the request reason is `0 (Future Appointment)`."
    },
    "requestingProviderEmail": {
      "type": "string",
      "description": "Email address of the provider or physician making the request."
    },
    "patientAuthFile": {
      "description": "Base-64 encoded file data for the patient authorization file, if available.",
      "allOf": [
        {
          "$ref": "#/$defs/EncodedFileInpDto"
        }
      ]
    },
    "referenceId": {
      "type": "string",
      "description": "User-defined reference number for the request. This can be used for your own records and is not used by the Predoc platform."
    },
    "sendHieRequest": {
      "type": "boolean",
      "description": "Send HIE request."
    },
    "sendMedicationsRequest": {
      "type": "boolean",
      "description": "Send Medications request."
    },
    "facesheetConfigId": {
      "type": "string",
      "description": "Facesheet config ID to generate request with."
    },
    "facesheetConfigIds": {
      "description": "Facesheet config IDs to generate request with.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "firstName": {
      "type": "string",
      "description": "First name of the patient.",
      "minLength": 2,
      "maxLength": 45
    },
    "middleInitial": {
      "type": "string",
      "description": "Middle initial of the patient."
    },
    "lastName": {
      "type": "string",
      "description": "Last name of the patient.",
      "minLength": 2,
      "maxLength": 60
    },
    "dateOfBirth": {
      "type": "string",
      "description": "Date of birth of the patient, in `YYYY-MM-DD` format."
    },
    "phoneCountryCode": {
      "type": "string",
      "deprecated": true,
      "description": "Country code of the patient's phone number with a `+` at the beginning. Defaults to +1."
    },
    "phoneNumber": {
      "type": "string",
      "description": "Phone number of the patient, with no special characters (only digits).",
      "minLength": 10,
      "maxLength": 10
    },
    "email": {
      "type": "string",
      "description": "Email address of the patient."
    },
    "patientAddress": {
      "description": "Physical address of the patient.",
      "allOf": [
        {
          "$ref": "#/$defs/AddressInpDto"
        }
      ]
    },
    "patientGender": {
      "type": "string",
      "description": "Gender of the patient.",
      "enum": [
        "male",
        "female",
        "na",
        "other"
      ]
    },
    "allowDuplicatePatient": {
      "type": "boolean",
      "description": "Override the patient demographics check and create the patient regardless of whether a patient with the same PII exists."
    }
  },
  "required": [
    "releaseToOrgName",
    "releaseToProviderName",
    "previousProviders",
    "reasonForRequest",
    "requestingProviderEmail",
    "firstName",
    "lastName",
    "dateOfBirth",
    "phoneNumber",
    "patientAddress",
    "patientGender"
  ],
  "$defs": {
    "AddressInpDto": {
      "type": "object",
      "properties": {
        "addressLine1": {
          "type": "string",
          "description": "Street address line 1."
        },
        "addressLine2": {
          "type": "string",
          "description": "Street address line 2."
        },
        "city": {
          "type": "string",
          "description": "Name of the city."
        },
        "stateCode": {
          "type": "string",
          "description": "Two letter state code for the address."
        },
        "postalCode": {
          "type": "string",
          "description": "Postal code for the address - 5 digits."
        },
        "countryCode": {
          "type": "string",
          "description": "<strong>NOTE:</strong> This field is deprecated and will be removed in a future release.",
          "default": "USA",
          "deprecated": true
        }
      },
      "required": [
        "postalCode"
      ]
    },
    "AddressPreviousProviderInpDto": {
      "type": "object",
      "properties": {
        "addressLine1": {
          "type": "string",
          "description": "Street address line 1."
        },
        "addressLine2": {
          "type": "string",
          "description": "Street address line 2."
        },
        "city": {
          "type": "string",
          "description": "Name of the city."
        },
        "stateCode": {
          "type": "string",
          "description": "Two letter state code for the address."
        },
        "postalCode": {
          "type": "string",
          "description": "Postal code for the address - 5 digits."
        },
        "countryCode": {
          "type": "string",
          "description": "<strong>NOTE:</strong> This field is deprecated and will be removed in a future release.",
          "default": "USA",
          "deprecated": true
        }
      }
    },
    "EncodedFileInpDto": {
      "type": "object",
      "properties": {
        "encodedFile": {
          "type": "string",
          "description": "Base-64 encoded data of the file being uploaded.",
          "format": "base64"
        },
        "fileExtension": {
          "type": "string",
          "description": "File extension of the file being uploaded."
        },
        "dataType": {
          "type": "string",
          "description": "Type of the file being uploaded."
        }
      },
      "required": [
        "encodedFile",
        "fileExtension",
        "dataType"
      ]
    },
    "PreviousProviderInpDto": {
      "type": "object",
      "properties": {
        "orgName": {
          "type": "string",
          "description": "Full name of the organization provider. This is only required when `providerFirstName` and `providerLastName` are not used."
        },
        "providerFirstName": {
          "type": "string",
          "description": "First name of the provider. This is only required when `orgName` is not used."
        },
        "providerLastName": {
          "type": "string",
          "description": "Last name of the provider. This is only required when `orgName` is not used."
        },
        "practiceName": {
          "type": "string",
          "description": "Provider's practice name."
        },
        "orgAddress": {
          "description": "Physical address of the organization's provider.",
          "allOf": [
            {
              "$ref": "#/$defs/AddressPreviousProviderInpDto"
            }
          ]
        },
        "orgPhoneCountryCode": {
          "type": "string",
          "default": "+1",
          "deprecated": true,
          "description": "Country code of the organization's phone number with a + at the beginning."
        },
        "orgPhoneNumber": {
          "type": "string",
          "description": "Phone number of the organization, with no special characters (digits only)."
        },
        "orgFaxNumber": {
          "type": "string",
          "description": "Fax number of the organization, with no special characters (digits only)."
        },
        "datesOfService": {
          "description": "Date range of when the organization provided care to the patient.",
          "allOf": [
            {
              "$ref": "#/$defs/RequestDatesOfServiceInpDto"
            }
          ]
        },
        "specificMedicalRecordRequested": {
          "type": "string",
          "description": "Type of custom document requested, if necessary."
        }
      },
      "required": [
        "orgName",
        "providerFirstName",
        "providerLastName",
        "datesOfService"
      ]
    },
    "RequestDatesOfServiceInpDto": {
      "type": "object",
      "properties": {
        "serviceStartDate": {
          "type": "string",
          "description": "Date of when the organization started providing care to the patient."
        },
        "serviceEndDate": {
          "type": "string",
          "description": "End date of when the organization stopped providing care to the patient."
        }
      },
      "required": [
        "serviceStartDate",
        "serviceEndDate"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/predoc-create-patient-with-crr-v2-inp-dto"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.