REST v1

One health-pattern finding (beta)

Recomputed for the same window; when the record changed, the finding gets a new id and this one answers 404.

get/v1/patients/{patient_id}/patterns/{finding_id}

Request

  • Base URL: https://platform.anpheros.com
  • URL: https://platform.anpheros.com/v1/patients/{patient_id}/patterns/{finding_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://platform.anpheros.com/oauth/authorize, token URL https://platform.anpheros.com/oauth/token; client credentials, token URL https://platform.anpheros.com/oauth/token, scopes: patient/*.rs, patient/Observation.rs, patient/Observation.rs?category=laboratory, patient/Condition.rs, patient/MedicationStatement.rs, patient/DocumentReference.rs, patient/AllergyIntolerance.rs, offline_access, openid, fhirUser, anpheros/patterns)

Path parameters

patient_idstring required
finding_idstring required

Query parameters

endstring date nullable

Last day of the window (UTC, ISO date); default today

window_daysinteger

Days in the analysis window, ending on end

Headers

authorizationstring nullable
X-Api-Keystring nullable
X-Anpheros-Acting-Asstring nullable
X-Anpheros-On-Behalf-Ofstring nullable

Response

Successful Response

idstring required
patientstring required
type'trend' | 'baseline_deviation' | 'recurrence' | 'association' | 'convergence' required
subtypestring nullable
epistemic_status'descriptive_observation' | 'statistical_association' | 'validated_prediction' required
strength'strong' | 'moderate' | 'weak' | 'not_tested' required
statistically_supportedboolean required
summary_codestring required
summary_textstring required
variablesobject[] required
windowobject required
comparison_windowobject nullable
resultobject required
statisticsobject nullable
thresholdobject nullable
evidenceobject[] required
evidence_totalinteger required
limitationsobject[] required
methodobject required
engine_versionstring required
input_fingerprintstring required
config_fingerprintstring required
safetyobject required
reviewobject required

Changes

No recorded changes to this operation across all 2 revisions of this API.