Create a new summary template

POST/fhir2summary/template
RequiresBearerauthentication

Body parameters

namestringrequired
descriptionstringoptional
example_summarystringrequired
target_resourcesstring[]required
example_fhir_dataobjectoptional
modestringrequired
Returns  

Response fields

successbooleanoptional
messagestringoptional
template_idstring (uuid)optional
templateobjectoptional
idstring (uuid)optional
namestringoptional
descriptionstringoptional
templatestringoptional
target_resourcesstring[]optional
modestringoptional
metadataobjectoptional
created_atstring (date-time)optional
updated_atstring (date-time)optional
POSTRequest
# Get authentication token
PHENOML_TOKEN=$(curl -X POST "https://experiment.app.pheno.ml/v2/auth/token" \
  -u "$PHENOML_CLIENT_ID:$PHENOML_CLIENT_SECRET" \
  | jq -r '.access_token')

curl -X POST "https://experiment.app.pheno.ml/fhir2summary/template" \
  -H "Authorization: Bearer $PHENOML_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Discharge Summary",
  "example_summary": "Patient John Doe, age 45, was admitted on 2024-01-10 with Type 2 Diabetes. Discharged on 2024-01-15 with Metformin 500mg BID.",
  "target_resources": [
    "Patient",
    "Condition",
    "MedicationRequest"
  ],
  "mode": "narrative"
}'
200 OKExample Response
{
  "success": true,
  "message": "Template created successfully",
  "template_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "template": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Discharge Summary",
    "template": "Patient <<Patient.name[0].text>>, age <<Patient.birthDate|age>>, was admitted on <<Encounter[0].period.start>> with <<Condition[0].code.coding[0].display>>. Discharged on <<Encounter[0].period.end>> with <<MedicationRequest[0].medicationCodeableConcept.coding[0].display>> <<MedicationRequest[0].dosageInstruction[0].text>>.",
    "target_resources": [
      "Patient",
      "Condition",
      "MedicationRequest"
    ],
    "mode": "narrative",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}