Update a summary template

PUT/fhir2summary/template/{id}

Updates an existing summary template

RequiresBearerauthentication

Path parameters

idstringrequired

Template ID

Body parameters

namestringrequired

descriptionstringoptional

templatestringrequired

Updated template with placeholders

target_resourcesstring[]required

modestringrequired

Template mode

Returns

Template updated successfully

Response fields

successbooleanoptional

messagestringoptional

templateobjectoptional

idstring (uuid)optional

namestringoptional

descriptionstringoptional

templatestringoptional

Template with {{resource.field}} placeholders

target_resourcesstring[]optional

List of FHIR resource types/profiles

modestringoptional

Template mode (stored value)

metadataobjectoptional

created_atstring (date-time)optional

updated_atstring (date-time)optional

PUTRequest

# 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 PUT "https://experiment.app.pheno.ml/fhir2summary/template/{id}" \
  -H "Authorization: Bearer $PHENOML_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Discharge Summary",
  "template": "Patient {{Patient.name[0].text}} was discharged on {{Encounter[0].period.end}} with {{MedicationRequest[0].medicationCodeableConcept.coding[0].display}} {{MedicationRequest[0].dosageInstruction[0].text}}.",
  "target_resources": [
    "Patient",
    "Encounter",
    "MedicationRequest"
  ],
  "mode": "narrative"
}'

200 OKExample Response

{
  "success": true,
  "message": "Template updated successfully",
  "template": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Discharge Summary",
    "template": "Patient <<Patient.name[0].text>> was discharged on <<Encounter[0].period.end>> with <<MedicationRequest[0].medicationCodeableConcept.coding[0].display>> <<MedicationRequest[0].dosageInstruction[0].text>>.",
    "target_resources": [
      "Patient",
      "Encounter",
      "MedicationRequest"
    ],
    "mode": "narrative",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-02-20T11:00:00Z"
  }
}