Amgen Portal API

# Symptom Enquiries

The Symptom Enquiries API enables the creation, retrieval, updating, and deletion of symptom enquiries, each of which can be associated with a patient, conversation, and multiple symptoms.

# Get Symptom Enquiries List

Retrieve a list of all symptom enquiries.

  • URL: patients/symptom-enquiries/
  • Method: GET
  • Response Example:
    [
  {
    "unique_id": "enq123",
    "patient_id": "pat001",
    "conversation_id": "con123",
    "enquiry_summary": "Patient reports persistent cough.",
    "feedback_summary": "Suggested monitoring symptoms and visiting doctor if persists.",
    "symptoms": [
      {
        "unique_id": "sym001",
        "symptom_name": "Cough",
        "symptom_details": "Dry and persistent."
      },
      {
        "unique_id": "sym002",
        "symptom_name": "Fever",
        "symptom_details": "Mild fever in the evenings."
      }
    ],
    "date_created": "2023-01-01T12:00:00Z",
    "last_updated": "2023-01-01T12:00:00Z"
  }
]

# Create Symptom Enquiry

For creating a Symptom Enquiry, you’ll need to explicitly include patient_id and conversation_id to ensure proper association with a specific patient and conversation. Here’s how the request format would look, including patient_id and conversation_id:

  • URL: patients/symptom-enquiries/

  • Method: POST

  • Request Example:

    {
  "patient_id": "pat001",
  "conversation_id": "con123",
  "enquiry_summary": "Patient reports headaches and nausea.",
  "feedback_summary": "Recommended hydration and over-the-counter pain relief.",
  "symptom_ids": ["sym001", "sym003"]
}
    • Explanation:
      • patient_id specifies the patient associated with this enquiry.
      • conversation_id links the enquiry to a specific conversation between the patient and healthcare provider or assistant.
      • symptom_ids associates the enquiry with relevant symptoms using unique IDs.

  • Response Example:

    {
  "unique_id": "enq124",
  "patient_id": "pat001",
  "conversation_id": "con123",
  "enquiry_summary": "Patient reports headaches and nausea.",
  "feedback_summary": "Recommended hydration and over-the-counter pain relief.",
  "symptoms": [
    {
      "unique_id": "sym001",
      "symptom_name": "Headache",
      "symptom_details": "Mild to moderate intensity."
    },
    {
      "unique_id": "sym003",
      "symptom_name": "Nausea",
      "symptom_details": "Occurs in the morning."
    }
  ],
  "date_created": "2023-01-01T14:00:00Z",
  "last_updated": "2023-01-01T14:00:00Z"
}

# Get a Symptom Enquiry

Retrieve details of a specific symptom enquiry by its unique ID.

  • URL: patients/symptom-enquiries/<str:unique_id>/
  • Method: GET
  • Response Example:
    {
  "unique_id": "enq123",
  "patient_id": "pat001",
  "conversation_id": "con123",
  "enquiry_summary": "Patient reports persistent cough.",
  "feedback_summary": "Suggested monitoring symptoms and visiting doctor if persists.",
  "symptoms": [
    {
      "unique_id": "sym001",
      "symptom_name": "Cough",
      "symptom_details": "Dry and persistent."
    },
    {
      "unique_id": "sym002",
      "symptom_name": "Fever",
      "symptom_details": "Mild fever in the evenings."
    }
  ],
  "date_created": "2023-01-01T12:00:00Z",
  "last_updated": "2023-01-01T12:00:00Z"
}

# Update a Symptom Enquiry

Update an existing symptom enquiry by its unique ID.

  • URL: patients/symptom-enquiries/<str:unique_id>/
  • Method: PUT
  • Request Example:
    {
  "enquiry_summary": "Updated symptom enquiry summary.",
  "feedback_summary": "Updated feedback summary.",
  "symptom_ids": ["sym004"]
}
  • Response Example:
    {
  "unique_id": "enq123",
  "patient_id": "pat001",
  "conversation_id": "con123",
  "enquiry_summary": "Updated symptom enquiry summary.",
  "feedback_summary": "Updated feedback summary.",
  "symptoms": [
    {
      "unique_id": "sym004",
      "symptom_name": "Dizziness",
      "symptom_details": "Patient reports light-headedness occasionally."
    }
  ],
  "date_created": "2023-01-01T12:00:00Z",
  "last_updated": "2023-01-02T10:00:00Z"
}

# Delete a Symptom Enquiry

Delete a symptom enquiry by its unique ID.

  • URL: patients/symptom-enquiries/<str:unique_id>/
  • Method: DELETE
  • Response: 204 No Content

← Diagnosis →