Patient Registration

The patient must be enrolled in a specific follow-up program.

Endpoint: /integration/api/v1/follow-up-patient/{followupSlug}/{clientSlug}

To register the patient within a follow-up, it is necessary to use the follow-up slug and the client slug.

info

The request must use the PUT method, as described in the endpoint documentation.

Example:

curl --location --request PUT 'https://patient-care-homolog.azurefd.net/integration/api/v1/follow-up-patient/<followup-slug>/<client-slug>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "vacancyType": "Quantity",
  "name": "Paciente Teste",
  "cpf": "012345678901",
  "email": "paciente@email.com",
  "phone": "1134567890",
  "origin": "Pré-cadastro no site",
  "cellPhone": "11999999999",
  "doctorId": "F29B3364-0BB3-4A6B-B912-005F76EE75D7",
  "doctorType": "Auditor",
  "medication": "Medicamento",
  "diagnosticDate": "2020-11-18T19:28:24.037Z"
}'

Result:

{
  "id": "00000000-0000-0000-0000-000000000000",
  "followup": "string"
}

Fields

Field	Description	Required
VacancyType	Type of vacancy to be checked to allow for patient entry. See Vacancy check.	No
Name	Patient name.	Yes
CPF	Patient CPF.	Yes
Email	Patient email.	No
Phone	Patient phone number, DDD + Phone format. Ex: 1134567890.	No
Cellphone	Patient email, DDD + Cellphone with 9 digits. Ex: 11987654321.	No
Origin	Patient origin. For integration use the fixed string Pré-cadastro no site. Other origins are for internal use.	Yes
DoctorId	ID of the physician responsible for the patient. Use the doctor search to locate the physician by CRM and UF. If the physician is not found, this field can be omitted.	No
DoctorType	Type of the physician responsible for the patient: Prescriber: physician who prescribes the medicine Followup: physician who monitors the patient Auditor: auditor physician	No
DiagnosticDate	Diagnosis date, YYYY-MM-DDThh-mm-ssZ format, ISO-8601 standard.	No
BirthDate	Patient's date of birth, YYYY-MM-DDThh-mm-ssZ format, ISO-8601 standard.	No
Gender	Patient biological sex, Male or Female.	No
AcceptProgramTerms	Determines whether the patient has accepted the terms of participation in the program.	No
Observations	Additional patient information, open field.	No
MedicalPrescription	Field for sending the medical prescription file. Object with the following fields: - FileName: filename - ContentType: file type (ex: image/jpg, application/pdf) - Buffer: file bytes encoded as a base64 string - ImageUrl: Public URL of the file. Can be used in place of the buffer field.	No
ApprovingOpinion	Field for sending the approval report file. Object with the following fields: - FileName: filename - ContentType: file type (ex: image/jpg, application/pdf) - Buffer: file bytes encoded as a base64 string - ImageUrl: Public URL of the file. Can be used in place of the buffer field.	No
AcceptanceTermResponsible	Field for sending the guardian's responsibility term for underage patients. Object with the following fields: - FileName: filename - ContentType: file type (ex: image/jpg, application/pdf) - Buffer: file bytes encoded as a base64 string - ImageUrl: Public URL of the file. Can be used in place of the buffer field.	No

tip

If necessary, the medical prescription can be sent after the patient is registered on a specific endpoint:

Endpoint: /integration/api/v1/follow-up-patient/{followUpSlug}/{cpf}/medical-prescription