{ "swaggerDoc": { "swagger": "2.0", "definitions": { "AllergyIntolerance": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "status", "div" ] }, "identifier": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "recordedDate": { "type": "string", "minLength": 1 }, "_recordedDate": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } } }, "required": [ "fhir_comments" ] }, "recorder": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "reference" ] }, "patient": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "reference" ] }, "substance": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "fhir_comments", "coding" ] }, "status": { "type": "string", "minLength": 1 }, "_status": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } } }, "required": [ "fhir_comments" ] }, "criticality": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "_type": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } } }, "required": [ "fhir_comments" ] }, "category": { "type": "string", "minLength": 1 }, "_category": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } } }, "required": [ "fhir_comments" ] }, "lastOccurence": { "type": "string", "minLength": 1 }, "_lastOccurence": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } } }, "required": [ "fhir_comments" ] }, "reaction": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "description", "onset", "severity" ], "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "substance": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "fhir_comments", "coding" ] }, "manifestation": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } } } }, "description": { "type": "string", "minLength": 1 }, "onset": { "type": "string", "minLength": 1 }, "severity": { "type": "string", "minLength": 1 } } } } }, "required": [ "resourceType", "id", "text", "identifier", "recordedDate", "_recordedDate", "recorder", "patient", "substance", "status", "_status", "criticality", "type", "_type", "category", "_category", "lastOccurence", "_lastOccurence", "reaction" ] }, "CapabilityStatement": {}, "CarePlan": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "contained": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "resourceType", "id", "description", "status" ], "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "extension": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "url" ], "properties": { "extension": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "url" ], "properties": { "url": { "type": "string", "minLength": 1 }, "valueCodeableConcept": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] } } } }, "url": { "type": "string", "minLength": 1 } } } }, "subject": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } }, "required": [ "reference", "display" ] }, "description": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 } } } }, "subject": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } }, "required": [ "reference", "display" ] }, "status": { "type": "string", "minLength": 1 }, "period": { "type": "object", "properties": { "end": { "type": "string", "minLength": 1 } }, "required": [ "end" ] }, "addresses": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference", "display" ], "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "participant": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "role": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 } }, "required": [ "text" ] }, "member": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } }, "required": [ "reference", "display" ] } } } }, "goal": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference" ], "properties": { "reference": { "type": "string", "minLength": 1 } } } }, "activity": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "detail": { "type": "object", "properties": { "category": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "code": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 } }, "required": [ "text" ] }, "prohibited": { "type": "boolean" }, "scheduledTiming": { "type": "object", "properties": { "repeat": { "type": "object", "properties": { "frequency": { "type": "number" }, "period": { "type": "number" }, "periodUnits": { "type": "string", "minLength": 1 } }, "required": [ "frequency", "period", "periodUnits" ] } }, "required": [ "repeat" ] }, "performer": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference", "display" ], "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "category", "code", "prohibited", "scheduledTiming", "performer" ] } } } } }, "required": [ "resourceType", "id", "text", "contained", "subject", "status", "period", "addresses", "participant", "goal", "activity" ] }, "CareTeam": {}, "Condition": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "patient": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "code": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "text": { "type": "string", "minLength": 1 } }, "required": [ "coding", "text" ] }, "category": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "verificationStatus": { "type": "string", "minLength": 1 }, "severity": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "onsetDateTime": { "type": "string", "minLength": 1 }, "bodySite": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "text" ], "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "text": { "type": "string", "minLength": 1 } } } } }, "required": [ "resourceType", "id", "text", "patient", "code", "category", "verificationStatus", "severity", "onsetDateTime", "bodySite" ] }, "Device": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "status", "div" ] }, "identifier": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "type": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "text": { "type": "string", "minLength": 1 } }, "required": [ "coding", "text" ] }, "note": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "time", "text" ], "properties": { "authorReference": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "time": { "type": "string", "minLength": 1 }, "text": { "type": "string", "minLength": 1 } } } }, "status": { "type": "string", "minLength": 1 }, "manufacturer": { "type": "string", "minLength": 1 }, "model": { "type": "string", "minLength": 1 }, "lotNumber": { "type": "string", "minLength": 1 }, "contact": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } }, "required": [ "resourceType", "id", "text", "identifier", "type", "note", "status", "manufacturer", "model", "lotNumber", "contact" ] }, "DiagnosticReport": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "contained": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "resourceType", "id", "status" ], "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "_id": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } } }, "required": [ "fhir_comments" ] }, "status": { "type": "string", "minLength": 1 }, "code": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "text": { "type": "string", "minLength": 1 } }, "required": [ "coding", "text" ] }, "subject": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "performer": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference", "display" ], "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "valueQuantity": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "type": "string", "minLength": 1 }, "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } }, "required": [ "value", "unit", "system", "code" ] }, "referenceRange": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "low": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "type": "string", "minLength": 1 }, "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } }, "required": [ "value", "unit", "system", "code" ] }, "high": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "type": "string", "minLength": 1 }, "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } }, "required": [ "value", "unit", "system", "code" ] } } } } } } }, "identifier": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "status": { "type": "string", "minLength": 1 }, "category": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "code": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "text": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "coding", "text" ] }, "subject": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "encounter": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "effectiveDateTime": { "type": "string", "minLength": 1 }, "issued": { "type": "string", "minLength": 1 }, "_issued": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } } }, "required": [ "fhir_comments" ] }, "performer": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } }, "required": [ "reference", "display" ] }, "result": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference" ], "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "reference": { "type": "string", "minLength": 1 } } } }, "presentedForm": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "contentType", "language", "data", "title" ], "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "contentType": { "type": "string", "minLength": 1 }, "language": { "type": "string", "minLength": 1 }, "data": { "type": "string", "minLength": 1 }, "title": { "type": "string", "minLength": 1 } } } } }, "required": [ "resourceType", "id", "text", "contained", "identifier", "status", "category", "code", "subject", "encounter", "effectiveDateTime", "issued", "_issued", "performer", "result", "presentedForm" ] }, "DocumentReference": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "status", "div" ] }, "contained": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "resourceType", "id" ], "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "object", "properties": { "family": { "type": "array", "items": { "properties": {} } }, "given": { "type": "array", "items": { "properties": {} } } }, "required": [ "family", "given" ] }, "practitionerRole": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "managingOrganization": { "type": "object", "properties": { "display": { "type": "string", "minLength": 1 } }, "required": [ "display" ] }, "role": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 } }, "required": [ "text" ] }, "specialty": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1 } } } } } } } } } }, "masterIdentifier": { "type": "object", "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "system", "value" ] }, "identifier": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "subject": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "type": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "class": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "author": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference" ], "properties": { "reference": { "type": "string", "minLength": 1 } } } }, "custodian": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "authenticator": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "created": { "type": "string", "minLength": 1 }, "indexed": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "docStatus": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "relatesTo": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "code" ], "properties": { "code": { "type": "string", "minLength": 1 }, "target": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] } } } }, "description": { "type": "string", "minLength": 1 }, "securityLabel": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } } } }, "content": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "attachment": { "type": "object", "properties": { "contentType": { "type": "string", "minLength": 1 }, "language": { "type": "string", "minLength": 1 }, "url": { "type": "string", "minLength": 1 }, "size": { "type": "number" }, "hash": { "type": "string", "minLength": 1 } }, "required": [ "contentType", "language", "url", "size", "hash" ] }, "format": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } } } }, "context": { "type": "object", "properties": { "encounter": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "event": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } } } }, "period": { "type": "object", "properties": { "start": { "type": "string", "minLength": 1 }, "end": { "type": "string", "minLength": 1 } }, "required": [ "start", "end" ] }, "facilityType": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "practiceSetting": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "sourcePatientInfo": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "related": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "identifier": { "type": "object", "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "system", "value" ] }, "ref": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] } } } } }, "required": [ "encounter", "event", "period", "facilityType", "practiceSetting", "sourcePatientInfo", "related" ] } }, "required": [ "resourceType", "id", "text", "contained", "masterIdentifier", "identifier", "subject", "type", "class", "author", "custodian", "authenticator", "created", "indexed", "status", "docStatus", "relatesTo", "description", "securityLabel", "content", "context" ] }, "Encounter": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "status": { "type": "string", "minLength": 1 }, "class": { "type": "string", "minLength": 1 }, "patient": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] } }, "required": [ "resourceType", "id", "text", "status", "class", "patient" ] }, "Goal": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "extension": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "url" ], "properties": { "extension": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "url" ], "properties": { "url": { "type": "string", "minLength": 1 }, "valueCodeableConcept": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] } } } }, "url": { "type": "string", "minLength": 1 } } } }, "subject": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } }, "required": [ "reference", "display" ] }, "description": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "addresses": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference", "display" ], "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "resourceType", "id", "text", "extension", "subject", "description", "status", "addresses" ] }, "Immunization": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "identifier": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "status": { "type": "string", "minLength": 1 }, "date": { "type": "string", "minLength": 1 }, "vaccineCode": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } } } }, "text": { "type": "string", "minLength": 1 } }, "required": [ "coding", "text" ] }, "patient": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "wasNotGiven": { "type": "boolean" }, "reported": { "type": "boolean" }, "performer": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "requester": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "encounter": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "manufacturer": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "location": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "lotNumber": { "type": "string", "minLength": 1 }, "expirationDate": { "type": "string", "minLength": 1 }, "site": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "route": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "doseQuantity": { "type": "object", "properties": { "value": { "type": "number" }, "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } }, "required": [ "value", "system", "code" ] }, "note": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1 } } } }, "explanation": { "type": "object", "properties": { "reason": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } } } } } } } }, "required": [ "reason" ] }, "reaction": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "date", "reported" ], "properties": { "date": { "type": "string", "minLength": 1 }, "detail": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "reported": { "type": "boolean" } } } }, "vaccinationProtocol": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "doseSequence", "description", "series", "seriesDoses" ], "properties": { "doseSequence": { "type": "number" }, "description": { "type": "string", "minLength": 1 }, "authority": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "series": { "type": "string", "minLength": 1 }, "seriesDoses": { "type": "number" }, "targetDisease": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } } } } } } }, "doseStatus": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "doseStatusReason": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] } } } } }, "required": [ "resourceType", "id", "text", "identifier", "status", "date", "vaccineCode", "patient", "wasNotGiven", "reported", "performer", "requester", "encounter", "manufacturer", "location", "lotNumber", "expirationDate", "site", "route", "doseQuantity", "note", "explanation", "reaction", "vaccinationProtocol" ] }, "Location": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "extension": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "url", "valueString" ], "properties": { "url": { "type": "string", "minLength": 1 }, "valueString": { "type": "string", "minLength": 1 } } } }, "identifier": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "value" ], "properties": { "value": { "type": "string", "minLength": 1 } } } }, "status": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "description": { "type": "string", "minLength": 1 }, "mode": { "type": "string", "minLength": 1 }, "telecom": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value", "use" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "use": { "type": "string", "minLength": 1 } } } }, "address": { "type": "object", "properties": { "use": { "type": "string", "minLength": 1 }, "line": { "type": "array", "items": { "properties": {} } }, "city": { "type": "string", "minLength": 1 }, "postalCode": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "use", "line", "city", "postalCode", "country" ] }, "physicalType": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "position": { "type": "object", "properties": { "longitude": { "type": "number" }, "latitude": { "type": "number" }, "altitude": { "type": "number" } }, "required": [ "longitude", "latitude", "altitude" ] }, "managingOrganization": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] } }, "required": [ "resourceType", "id", "text", "extension", "identifier", "status", "name", "description", "mode", "telecom", "address", "physicalType", "position", "managingOrganization" ] }, "Medication": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "code": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 }, "_display": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } } }, "required": [ "fhir_comments" ] } } } } }, "required": [ "coding" ] }, "isBrand": { "type": "boolean" }, "package": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "container": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] } }, "required": [ "fhir_comments", "container" ] } }, "required": [ "resourceType", "id", "text", "code", "isBrand", "package" ] }, "MedicationRequest": {}, "Observation": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "status", "div" ] }, "status": { "type": "string", "minLength": 1 }, "category": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "fhir_comments", "coding" ] }, "code": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "fhir_comments", "coding" ] }, "subject": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "encounter": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "valueQuantity": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "value": { "type": "number" }, "unit": { "type": "string", "minLength": 1 }, "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "value", "unit", "system", "code" ] } }, "required": [ "resourceType", "id", "text", "status", "category", "code", "subject", "encounter", "valueQuantity" ] }, "Organization": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "extension": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "url", "valueString" ], "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "url": { "type": "string", "minLength": 1 }, "valueString": { "type": "string", "minLength": 1 } } } }, "name": { "type": "string", "minLength": 1 }, "telecom": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "address": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "city", "state", "postalCode", "country" ], "properties": { "line": { "type": "array", "items": { "properties": {} } }, "city": { "type": "string", "minLength": 1 }, "state": { "type": "string", "minLength": 1 }, "postalCode": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } } } } }, "required": [ "resourceType", "id", "text", "extension", "name", "telecom", "address" ] }, "Patient": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "identifier": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "use", "system", "value" ], "properties": { "use": { "type": "string", "minLength": 1 }, "type": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } } } } }, "required": [ "coding" ] }, "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "active": { "type": "boolean" }, "name": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "use" ], "properties": { "use": { "type": "string", "minLength": 1 }, "family": { "type": "array", "items": { "properties": {} } }, "given": { "type": "array", "items": { "properties": {} } } } } }, "gender": { "type": "string", "minLength": 1 }, "photo": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "contentType", "data" ], "properties": { "contentType": { "type": "string", "minLength": 1 }, "data": { "type": "string", "minLength": 1 } } } }, "contact": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "relationship": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } } } } } } }, "organization": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } }, "required": [ "reference", "display" ] } } } }, "managingOrganization": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } }, "required": [ "reference", "display" ] }, "link": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "type" ], "properties": { "other": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "type": { "type": "string", "minLength": 1 } } } } }, "required": [ "resourceType", "id", "text", "identifier", "active", "name", "gender", "photo", "contact", "managingOrganization", "link" ] }, "Practitioner": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "identifier": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "active": { "type": "boolean" }, "name": { "type": "object", "properties": { "family": { "type": "array", "items": { "properties": {} } }, "given": { "type": "array", "items": { "properties": {} } }, "prefix": { "type": "array", "items": { "properties": {} } } }, "required": [ "family", "given", "prefix" ] }, "practitionerRole": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "managingOrganization": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "role": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } } } } }, "required": [ "fhir_comments", "coding" ] }, "period": { "type": "object", "properties": { "start": { "type": "string", "minLength": 1 }, "end": { "type": "string", "minLength": 1 } }, "required": [ "start", "end" ] }, "location": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference", "display" ], "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "healthcareService": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference" ], "properties": { "reference": { "type": "string", "minLength": 1 } } } } } } }, "qualification": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "identifier": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "value" ], "properties": { "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "code": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 } }, "required": [ "text" ] }, "period": { "type": "object", "properties": { "start": { "type": "string", "minLength": 1 } }, "required": [ "start" ] }, "issuer": { "type": "object", "properties": { "display": { "type": "string", "minLength": 1 } }, "required": [ "display" ] } } } } }, "required": [ "resourceType", "id", "text", "identifier", "active", "name", "practitionerRole", "qualification" ] }, "Procedure": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "subject": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "status": { "type": "string", "minLength": 1 }, "code": { "type": "object", "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "text": { "type": "string", "minLength": 1 } }, "required": [ "coding", "text" ] }, "reasonCodeableConcept": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 } }, "required": [ "text" ] }, "performer": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "actor": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } }, "required": [ "reference", "display" ] } } } }, "performedDateTime": { "type": "string", "minLength": 1 }, "followUp": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1 } } } }, "notes": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1 } } } } }, "required": [ "resourceType", "id", "text", "subject", "status", "code", "reasonCodeableConcept", "performer", "performedDateTime", "followUp", "notes" ] }, "Provenance": { "description": "", "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "text": { "type": "object", "properties": { "status": { "type": "string", "minLength": 1 }, "div": { "type": "string", "minLength": 1 } }, "required": [ "status", "div" ] }, "target": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "reference" ], "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "reference": { "type": "string", "minLength": 1 } } } }, "period": { "type": "object", "properties": { "start": { "type": "string", "minLength": 1 } }, "required": [ "start" ] }, "recorded": { "type": "string", "minLength": 1 }, "reason": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "text" ], "properties": { "coding": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "system", "code", "display" ], "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } } } }, "text": { "type": "string", "minLength": 1 } } } }, "location": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "policy": { "type": "array", "items": { "properties": {} } }, "agent": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "role": { "type": "object", "properties": { "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } }, "required": [ "system", "code" ] }, "actor": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1 } }, "required": [ "reference" ] }, "userId": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "system": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "system", "value" ] }, "relatedAgent": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "target" ], "properties": { "type": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 } }, "required": [ "text" ] }, "target": { "type": "string", "minLength": 1 } } } } } } }, "entity": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "role", "reference", "display" ], "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "role": { "type": "string", "minLength": 1 }, "type": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } }, "system": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "display": { "type": "string", "minLength": 1 } }, "required": [ "fhir_comments", "system", "code", "display" ] }, "reference": { "type": "string", "minLength": 1 }, "_reference": { "type": "object", "properties": { "fhir_comments": { "type": "array", "items": { "properties": {} } } }, "required": [ "fhir_comments" ] }, "display": { "type": "string", "minLength": 1 } } } } }, "required": [ "resourceType", "id", "text", "target", "period", "recorded", "reason", "location", "policy", "agent", "entity" ] } }, "paths": { "/AllergyIntolerance": { "get": { "description": "US Core AllergyIntolerance Profile - Queries for Allergies belonging to a Patient\n - Allergies & Intolerances\n - Substance (Medication)\n - Substance (Drug Class)\n - Reaction", "tags": [ "AllergyIntolerance" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "asserter", "type": "string", "in": "query", "description": "Source of the information about the allergy" }, { "name": "category", "type": "string", "in": "query", "description": "food | medication | environment | biologic" }, { "name": "clinical-status", "type": "string", "in": "query", "description": "active | inactive | resolved" }, { "name": "code", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "criticality", "type": "string", "in": "query", "description": "low | high | unable-to-assess" }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "format": "date" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "last-date", "type": "string", "in": "query", "description": "Date(/time) of last known occurrence of a reaction", "format": "date" }, { "name": "manifestation", "type": "string", "in": "query", "description": "Clinical symptoms/signs associated with the Event" }, { "name": "onset", "type": "string", "in": "query", "description": "Date(/time) when manifestations showed", "format": "date" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "recorder", "type": "string", "in": "query", "description": "Who recorded the sensitivity" }, { "name": "route", "type": "string", "in": "query", "description": "How the subject was exposed to the substance" }, { "name": "severity", "type": "string", "in": "query", "description": "mild | moderate | severe (of event as a whole)" }, { "name": "type", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management" }, { "name": "verification-status", "type": "string", "in": "query", "description": "unconfirmed | confirmed | refuted | entered-in-error" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/AllergyIntolerance" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/AllergyIntolerance/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core AllergyIntolerance Profile - Queries for Allergies belonging to a Patient\n - Allergies & Intolerances\n - Substance (Medication)\n - Substance (Drug Class)\n - Reaction", "tags": [ "AllergyIntolerance" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AllergyIntolerance" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/CapabilityStatement": { "get": { "tags": [ "CapabilityStatement" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "context", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set" }, { "name": "context-quantity", "type": "integer", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set" }, { "name": "context-type", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set" }, { "name": "context-type-quantity", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set" }, { "name": "context-type-value", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set" }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date", "format": "date" }, { "name": "description", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set" }, { "name": "fhirversion", "type": "string", "in": "query", "description": "The version of FHIR" }, { "name": "format", "type": "string", "in": "query", "description": "formats supported (xml | json | ttl | mime type)" }, { "name": "guide", "type": "string", "in": "query", "description": "Implementation guides supported" }, { "name": "jurisdiction", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set" }, { "name": "mode", "type": "string", "in": "query", "description": "Mode - restful (server/client) or messaging (sender/receiver)" }, { "name": "name", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set" }, { "name": "publisher", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set" }, { "name": "resource", "type": "string", "in": "query", "description": "Name of a resource mentioned in a capability statement" }, { "name": "resource-profile", "type": "string", "in": "query", "description": "A profile id invoked in a capability statement" }, { "name": "security-service", "type": "string", "in": "query", "description": "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates" }, { "name": "software", "type": "string", "in": "query", "description": "Part of the name of a software application" }, { "name": "status", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set" }, { "name": "supported-profile", "type": "string", "in": "query", "description": "Profiles for use cases supported" }, { "name": "title", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set" }, { "name": "url", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set" }, { "name": "version", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/CapabilityStatement" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/CarePlan": { "get": { "description": "US Core CarePlan Profile - Query for a Care Plan belonging to a Patient.\n - Assessment and Plan of Treatment ", "tags": [ "CarePlan" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "activity-code", "type": "string", "in": "query", "description": "Detail type of activity" }, { "name": "activity-date", "type": "string", "in": "query", "description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]", "format": "date" }, { "name": "activity-reference", "type": "string", "in": "query", "description": "Activity details defined in specific resource" }, { "name": "based-on", "type": "string", "in": "query", "description": "Fulfills CarePlan" }, { "name": "care-team", "type": "string", "in": "query", "description": "Who's involved in plan?" }, { "name": "category", "type": "string", "in": "query", "description": "Type of plan" }, { "name": "condition", "type": "string", "in": "query", "description": "Health issues this plan addresses" }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "format": "date" }, { "name": "encounter", "type": "string", "in": "query", "description": "Encounter created as part of" }, { "name": "goal", "type": "string", "in": "query", "description": "Desired outcome of plan" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "instantiates-canonical", "type": "string", "in": "query", "description": "Instantiates FHIR protocol or definition" }, { "name": "instantiates-uri", "type": "string", "in": "query", "description": "Instantiates external protocol or definition" }, { "name": "intent", "type": "string", "in": "query", "description": "proposal | plan | order | option" }, { "name": "part-of", "type": "string", "in": "query", "description": "Part of referenced CarePlan" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "performer", "type": "string", "in": "query", "description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)" }, { "name": "replaces", "type": "string", "in": "query", "description": "CarePlan replaced by this CarePlan" }, { "name": "status", "type": "string", "in": "query", "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown" }, { "name": "subject", "type": "string", "in": "query", "description": "Who the care plan is for" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/CarePlan" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/CarePlan/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core CarePlan Profile - Query for a Care Plan belonging to a Patient.\n - Assessment and Plan of Treatment ", "tags": [ "CarePlan" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CarePlan" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/CareTeam": { "get": { "description": "US Core CareTeam Profile - Query for a Patient's Care Team.\n - Care Team Members", "tags": [ "CareTeam" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "category", "type": "string", "in": "query", "description": "Type of team" }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "format": "date" }, { "name": "encounter", "type": "string", "in": "query", "description": "Encounter created as part of" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "participant", "type": "string", "in": "query", "description": "Who is involved" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "status", "type": "string", "in": "query", "description": "proposed | active | suspended | inactive | entered-in-error" }, { "name": "subject", "type": "string", "in": "query", "description": "Who care team is for" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/CareTeam" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/CareTeam/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core CareTeam Profile - Query for a Patient's Care Team.\n - Care Team Members", "tags": [ "CareTeam" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CareTeam" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Condition": { "get": { "description": "US Core Condition Problems and Health Concerns Profile - Query for a Patient's Problems and Health Concerns.\n - Health Concerns\n - Problems", "tags": [ "Condition" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "abatement-age", "type": "integer", "in": "query", "description": "Abatement as age or age range" }, { "name": "abatement-date", "type": "string", "in": "query", "description": "Date-related abatements (dateTime and period)", "format": "date" }, { "name": "abatement-string", "type": "string", "in": "query", "description": "Abatement as a string" }, { "name": "asserter", "type": "string", "in": "query", "description": "Person who asserts this condition" }, { "name": "body-site", "type": "string", "in": "query", "description": "Anatomical location, if relevant" }, { "name": "category", "type": "string", "in": "query", "description": "The category of the condition" }, { "name": "clinical-status", "type": "string", "in": "query", "description": "The clinical status of the condition" }, { "name": "code", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "encounter", "type": "string", "in": "query", "description": "Encounter created as part of" }, { "name": "evidence", "type": "string", "in": "query", "description": "Manifestation/symptom" }, { "name": "evidence-detail", "type": "string", "in": "query", "description": "Supporting information found elsewhere" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "onset-age", "type": "integer", "in": "query", "description": "Onsets as age or age range" }, { "name": "onset-date", "type": "string", "in": "query", "description": "Date related onsets (dateTime and Period)", "format": "date" }, { "name": "onset-info", "type": "string", "in": "query", "description": "Onsets as a string" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "recorded-date", "type": "string", "in": "query", "description": "Date record was first recorded", "format": "date" }, { "name": "severity", "type": "string", "in": "query", "description": "The severity of the condition" }, { "name": "stage", "type": "string", "in": "query", "description": "Simple summary (disease specific)" }, { "name": "subject", "type": "string", "in": "query", "description": "Who has the condition?" }, { "name": "verification-status", "type": "string", "in": "query", "description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Condition" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Condition/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Condition Problems and Health Concerns Profile - Query for a Patient's Problems and Health Concerns.\n - Health Concerns\n - Problems", "tags": [ "Condition" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Condition" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Device": { "get": { "description": "US Core Implantable Device Profile - Query for a Patient's Implantable Devices.\n - Unique Device Identifier(s) for a Patient's Implantable Device(s)", "tags": [ "Device" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "device-name", "type": "string", "in": "query", "description": "A server defined search that may match any of the string fields in Device.deviceName or Device.type." }, { "name": "din", "type": "string", "in": "query", "description": "The donation identification number (DIN)" }, { "name": "identifier", "type": "string", "in": "query", "description": "Instance id from manufacturer, owner, and others" }, { "name": "location", "type": "string", "in": "query", "description": "A location, where the resource is found" }, { "name": "manufacturer", "type": "string", "in": "query", "description": "The manufacturer of the device" }, { "name": "model", "type": "string", "in": "query", "description": "The model of the device" }, { "name": "organization", "type": "string", "in": "query", "description": "The organization responsible for the device" }, { "name": "patient", "type": "string", "in": "query", "description": "Patient information, if the resource is affixed to a person" }, { "name": "status", "type": "string", "in": "query", "description": "active | inactive | entered-in-error | unknown" }, { "name": "type", "type": "string", "in": "query", "description": "The type of the device" }, { "name": "udi-carrier", "type": "string", "in": "query", "description": "UDI Barcode (RFID or other technology) string in *HRF* format." }, { "name": "udi-di", "type": "string", "in": "query", "description": "The udi Device Identifier (DI)" }, { "name": "url", "type": "string", "in": "query", "description": "Network address to contact device" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Device/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Implantable Device Profile - Query for a Patient's Implantable Devices.\n - Unique Device Identifier(s) for a Patient's Implantable Device(s)", "tags": [ "Device" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Device" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/DiagnosticReport": { "get": { "description": "US Core LaboratoryResult Observation - Query for Lab reports belonging to a Patient.\n - Tests\n - Values/Results\n\n US Core DiagnosticReport for Report and Note Exchange - Query for a specific clinical test result.\n - Clinical Notes", "tags": [ "DiagnosticReport" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "based-on", "type": "string", "in": "query", "description": "Reference to the service request." }, { "name": "category", "type": "string", "in": "query", "description": "Which diagnostic discipline/department created the report" }, { "name": "code", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "conclusion", "type": "string", "in": "query", "description": "A coded conclusion (interpretation/impression) on the report" }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "format": "date" }, { "name": "encounter", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "issued", "type": "string", "in": "query", "description": "When the report was issued", "format": "date" }, { "name": "media", "type": "string", "in": "query", "description": "A reference to the image source." }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "performer", "type": "string", "in": "query", "description": "Who is responsible for the report" }, { "name": "result", "type": "string", "in": "query", "description": "Link to an atomic result (observation resource)" }, { "name": "results-interpreter", "type": "string", "in": "query", "description": "Who was the source of the report" }, { "name": "specimen", "type": "string", "in": "query", "description": "The specimen details" }, { "name": "status", "type": "string", "in": "query", "description": "The status of the report" }, { "name": "subject", "type": "string", "in": "query", "description": "The subject of the report" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/DiagnosticReport" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/DiagnosticReport/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core LaboratoryResult Observation - Query for Lab reports belonging to a Patient.\n - Tests\n - Values/Results\n\n US Core DiagnosticReport for Report and Note Exchange - Query for a specific clinical test result.\n - Clinical Notes", "tags": [ "DiagnosticReport" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DiagnosticReport" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/DocumentReference": { "get": { "description": "US Core DocumentReference Profile - Query for all documents belonging to a Patient.\n - Clinical Notes", "tags": [ "DocumentReference" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "**Logical id of this artifact** \n**NOTE**: This US Core SearchParameter definition extends the usage context of the\n[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)\n - multipleAnd\n - multipleOr\n - comparator\n - modifier\n - chain" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "authenticator", "type": "string", "in": "query", "description": "Who/what authenticated the document" }, { "name": "author", "type": "string", "in": "query", "description": "Who and/or what authored the document" }, { "name": "category", "type": "string", "in": "query", "description": "Categorization of document" }, { "name": "contenttype", "type": "string", "in": "query", "description": "Mime type of the content, with charset etc." }, { "name": "custodian", "type": "string", "in": "query", "description": "Organization which maintains the document" }, { "name": "date", "type": "string", "in": "query", "description": "When this document reference was created", "format": "date" }, { "name": "description", "type": "string", "in": "query", "description": "Human-readable description" }, { "name": "encounter", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier" }, { "name": "event", "type": "string", "in": "query", "description": "Main clinical acts documented" }, { "name": "facility", "type": "string", "in": "query", "description": "Kind of facility where patient was seen" }, { "name": "format", "type": "string", "in": "query", "description": "Format/content rules for the document" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "language", "type": "string", "in": "query", "description": "Human language of the content (BCP-47)" }, { "name": "location", "type": "string", "in": "query", "description": "Uri where the data can be found" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "period", "type": "string", "in": "query", "description": "Time of service that is being documented", "format": "date" }, { "name": "related", "type": "string", "in": "query", "description": "Related identifiers or resources" }, { "name": "relatesto", "type": "string", "in": "query", "description": "Target of the relationship" }, { "name": "relation", "type": "string", "in": "query", "description": "replaces | transforms | signs | appends" }, { "name": "relationship", "type": "string", "in": "query", "description": "Combination of relation and relatesTo" }, { "name": "security-label", "type": "string", "in": "query", "description": "Document security-tags" }, { "name": "setting", "type": "string", "in": "query", "description": "Additional details about where the content was created (e.g. clinical specialty)" }, { "name": "status", "type": "string", "in": "query", "description": "current | superseded | entered-in-error" }, { "name": "subject", "type": "string", "in": "query", "description": "Who/what is the subject of the document" }, { "name": "type", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/DocumentReference" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/DocumentReference/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core DocumentReference Profile - Query for all documents belonging to a Patient.\n - Clinical Notes", "tags": [ "DocumentReference" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DocumentReference" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Encounter": { "get": { "description": "US Core Encounter Profile - Query for Patient Encounter.\n - Encounter Information", "tags": [ "Encounter" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "**Logical id of this artifact** \n**NOTE**: This US Core SearchParameter definition extends the usage context of the\n[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)\n - multipleAnd\n - multipleOr\n - comparator\n - modifier\n - chain" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "account", "type": "string", "in": "query", "description": "The set of accounts that may be used for billing for this Encounter" }, { "name": "appointment", "type": "string", "in": "query", "description": "The appointment that scheduled this encounter" }, { "name": "based-on", "type": "string", "in": "query", "description": "The ServiceRequest that initiated this encounter" }, { "name": "class", "type": "string", "in": "query", "description": "Classification of patient encounter" }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "format": "date" }, { "name": "diagnosis", "type": "string", "in": "query", "description": "The diagnosis or procedure relevant to the encounter" }, { "name": "episode-of-care", "type": "string", "in": "query", "description": "Episode(s) of care that this encounter should be recorded against" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "length", "type": "integer", "in": "query", "description": "Length of encounter in days" }, { "name": "location", "type": "string", "in": "query", "description": "Location the encounter takes place" }, { "name": "location-period", "type": "string", "in": "query", "description": "Time period during which the patient was present at the location", "format": "date" }, { "name": "participant", "type": "string", "in": "query", "description": "Persons involved in the encounter other than the patient" }, { "name": "participant-type", "type": "string", "in": "query", "description": "Role of participant in encounter" }, { "name": "part-of", "type": "string", "in": "query", "description": "Another Encounter this encounter is part of" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "practitioner", "type": "string", "in": "query", "description": "Persons involved in the encounter other than the patient" }, { "name": "reason-code", "type": "string", "in": "query", "description": "Coded reason the encounter takes place" }, { "name": "reason-reference", "type": "string", "in": "query", "description": "Reason the encounter takes place (reference)" }, { "name": "service-provider", "type": "string", "in": "query", "description": "The organization (facility) responsible for this encounter" }, { "name": "special-arrangement", "type": "string", "in": "query", "description": "Wheelchair, translator, stretcher, etc." }, { "name": "status", "type": "string", "in": "query", "description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +" }, { "name": "subject", "type": "string", "in": "query", "description": "The patient or group present at the encounter" }, { "name": "type", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Encounter" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Encounter/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Encounter Profile - Query for Patient Encounter.\n - Encounter Information", "tags": [ "Encounter" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Encounter" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Goal": { "get": { "description": "US Core Goal Profile - Query for a Patient's Goals.\n - Patient Goals", "tags": [ "Goal" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "achievement-status", "type": "string", "in": "query", "description": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable" }, { "name": "category", "type": "string", "in": "query", "description": "E.g. Treatment, dietary, behavioral, etc." }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "lifecycle-status", "type": "string", "in": "query", "description": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "start-date", "type": "string", "in": "query", "description": "When goal pursuit begins", "format": "date" }, { "name": "subject", "type": "string", "in": "query", "description": "Who this goal is intended for" }, { "name": "target-date", "type": "string", "in": "query", "description": "Reach goal on or before", "format": "date" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Goal" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Goal/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Goal Profile - Query for a Patient's Goals.\n - Patient Goals", "tags": [ "Goal" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Goal" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Immunization": { "get": { "description": "US Core Immunization Profile - Query for Immunizations belonging to a Patient.\n - Immunizations", "tags": [ "Immunization" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "format": "date" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "location", "type": "string", "in": "query", "description": "The service delivery location or facility in which the vaccine was / was to be administered" }, { "name": "lot-number", "type": "string", "in": "query", "description": "Vaccine Lot Number" }, { "name": "manufacturer", "type": "string", "in": "query", "description": "Vaccine Manufacturer" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "performer", "type": "string", "in": "query", "description": "The practitioner or organization who played a role in the vaccination" }, { "name": "reaction", "type": "string", "in": "query", "description": "Additional information on reaction" }, { "name": "reaction-date", "type": "string", "in": "query", "description": "When reaction started", "format": "date" }, { "name": "reason-code", "type": "string", "in": "query", "description": "Reason why the vaccine was administered" }, { "name": "reason-reference", "type": "string", "in": "query", "description": "Why immunization occurred" }, { "name": "series", "type": "string", "in": "query", "description": "The series being followed by the provider" }, { "name": "status", "type": "string", "in": "query", "description": "Immunization event status" }, { "name": "status-reason", "type": "string", "in": "query", "description": "Reason why the vaccine was not administered" }, { "name": "target-disease", "type": "string", "in": "query", "description": "The target disease the dose is being administered against" }, { "name": "vaccine-code", "type": "string", "in": "query", "description": "Vaccine Product Administered" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Immunization" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Immunization/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Immunization Profile - Query for Immunizations belonging to a Patient.\n - Immunizations", "tags": [ "Immunization" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Immunization" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Location": { "get": { "description": "US Core Location Profile - Fetch Location associated with a Patient, Provider, or Organization.\n - Location", "tags": [ "Location" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "address", "type": "string", "in": "query", "description": "A (part of the) address of the location" }, { "name": "address-city", "type": "string", "in": "query", "description": "A city specified in an address" }, { "name": "address-country", "type": "string", "in": "query", "description": "A country specified in an address" }, { "name": "address-postalcode", "type": "string", "in": "query", "description": "A postal code specified in an address" }, { "name": "address-state", "type": "string", "in": "query", "description": "A state specified in an address" }, { "name": "address-use", "type": "string", "in": "query", "description": "A use code specified in an address" }, { "name": "endpoint", "type": "string", "in": "query", "description": "Technical endpoints providing access to services operated for the location" }, { "name": "identifier", "type": "string", "in": "query", "description": "An identifier for the location" }, { "name": "name", "type": "string", "in": "query", "description": "A portion of the location's name or alias" }, { "name": "near", "type": "string", "in": "query", "description": "Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).\nIf the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)\n\nServers may search using various techniques that might have differing accuracies, depending on implementation efficiency.\n\nRequires the near-distance parameter to be provided also" }, { "name": "operational-status", "type": "string", "in": "query", "description": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)" }, { "name": "organization", "type": "string", "in": "query", "description": "Searches for locations that are managed by the provided organization" }, { "name": "partof", "type": "string", "in": "query", "description": "A location of which this location is a part" }, { "name": "status", "type": "string", "in": "query", "description": "Searches for locations with a specific kind of status" }, { "name": "type", "type": "string", "in": "query", "description": "A code for the type of location" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Location" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Location/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Location Profile - Fetch Location associated with a Patient, Provider, or Organization.\n - Location", "tags": [ "Location" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Location" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Medication": { "get": { "description": "US Core Medication Profile - Read Medication resources referenced in MedicationRequest resources.\n - Medications", "tags": [ "Medication" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "code", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "expiration-date", "type": "string", "in": "query", "description": "Returns medications in a batch with this expiration date", "format": "date" }, { "name": "form", "type": "string", "in": "query", "description": "Returns medications for a specific dose form" }, { "name": "identifier", "type": "string", "in": "query", "description": "Returns medications with this external identifier" }, { "name": "ingredient", "type": "string", "in": "query", "description": "Returns medications for this ingredient reference" }, { "name": "ingredient-code", "type": "string", "in": "query", "description": "Returns medications for this ingredient code" }, { "name": "lot-number", "type": "string", "in": "query", "description": "Returns medications in a batch with this lot number" }, { "name": "manufacturer", "type": "string", "in": "query", "description": "Returns medications made or sold for this manufacturer" }, { "name": "status", "type": "string", "in": "query", "description": "Returns medications for this status" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Medication" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Medication/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Medication Profile - Read Medication resources referenced in MedicationRequest resources.\n - Medications", "tags": [ "Medication" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Medication" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/MedicationRequest": { "get": { "description": "US Core MedicationRequest Profile - Fetching Medications that have been prescribed to a particular Patient.\n - Medications", "tags": [ "MedicationRequest" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "authoredon", "type": "string", "in": "query", "description": "Return prescriptions written on this date", "format": "date" }, { "name": "category", "type": "string", "in": "query", "description": "Returns prescriptions with different categories" }, { "name": "code", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date", "format": "date" }, { "name": "encounter", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "intended-dispenser", "type": "string", "in": "query", "description": "Returns prescriptions intended to be dispensed by this Organization" }, { "name": "intended-performer", "type": "string", "in": "query", "description": "Returns the intended performer of the administration of the medication request" }, { "name": "intended-performertype", "type": "string", "in": "query", "description": "Returns requests for a specific type of performer" }, { "name": "intent", "type": "string", "in": "query", "description": "Returns prescriptions with different intents" }, { "name": "medication", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "priority", "type": "string", "in": "query", "description": "Returns prescriptions with different priorities" }, { "name": "requester", "type": "string", "in": "query", "description": "Returns prescriptions prescribed by this prescriber" }, { "name": "status", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status" }, { "name": "subject", "type": "string", "in": "query", "description": "The identity of a patient to list orders for" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/MedicationRequest" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/MedicationRequest/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core MedicationRequest Profile - Fetching Medications that have been prescribed to a particular Patient.\n - Medications", "tags": [ "MedicationRequest" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/MedicationRequest" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Observation": { "get": { "description": "US Core Smoking Status Observation Profile - Query for the Smoking Status of a Patient.\n - Smoking Status\n\n US Core Vital Signs Profile - Fetch Vital Signs for a Patient.\n - US Core Pediatric Head Occipital-frontal Circumference Percentile Profile\n - Head Occipital-frontal Circumference Percentile (Birth - 36 Months)\n - US Core Blood Pressure Profile\n - Diastolic & Systolic Blood Pressure\n - US Core BMI Profile\n - BMI Percentile (2-20 Years)\n - US Core Body Height Profile\n - Body Height\n - US Core Body Temperature Profile\n - Body Temperature\n - US Core Body Weight Profile\n - Body Weight\n - US Core Heart Rate Profile\n - Heart Rate\n - US Core Pediatric BMI for Age Observation Profile\n - BMI Percentile (2-20 Years)\n - US Core Pediatric Weight for Height Observation Profile\n - Weight-for-length Percentile (Birth - 36 Months)\n - US Core Pulse Oximetry Profile\n - Pulse Oximetry\n - Inhaled Oxygen Concentration\n - US Core Respiratory Rate Profile\n - Respiratory Rate", "tags": [ "Observation" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "amino-acid-change", "type": "string", "in": "query", "description": "HGVS Protein Change" }, { "name": "based-on", "type": "string", "in": "query", "description": "Reference to the service request." }, { "name": "category", "type": "string", "in": "query", "description": "The classification of the type of observation" }, { "name": "code", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "code-value-concept", "type": "string", "in": "query", "description": "Code and coded value parameter pair" }, { "name": "code-value-date", "type": "string", "in": "query", "description": "Code and date/time value parameter pair" }, { "name": "code-value-quantity", "type": "string", "in": "query", "description": "Code and quantity value parameter pair" }, { "name": "code-value-string", "type": "string", "in": "query", "description": "Code and string value parameter pair" }, { "name": "combo-code", "type": "string", "in": "query", "description": "The code of the observation type or component type" }, { "name": "combo-code-value-concept", "type": "string", "in": "query", "description": "Code and coded value parameter pair, including in components" }, { "name": "combo-code-value-quantity", "type": "string", "in": "query", "description": "Code and quantity value parameter pair, including in components" }, { "name": "combo-data-absent-reason", "type": "string", "in": "query", "description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing." }, { "name": "combo-value-concept", "type": "string", "in": "query", "description": "The value or component value of the observation, if the value is a CodeableConcept" }, { "name": "combo-value-quantity", "type": "integer", "in": "query", "description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)" }, { "name": "component-code", "type": "string", "in": "query", "description": "The component code of the observation type" }, { "name": "component-code-value-concept", "type": "string", "in": "query", "description": "Component code and component coded value parameter pair" }, { "name": "component-code-value-quantity", "type": "string", "in": "query", "description": "Component code and component quantity value parameter pair" }, { "name": "component-data-absent-reason", "type": "string", "in": "query", "description": "The reason why the expected value in the element Observation.component.value[x] is missing." }, { "name": "component-value-concept", "type": "string", "in": "query", "description": "The value of the component observation, if the value is a CodeableConcept" }, { "name": "component-value-quantity", "type": "integer", "in": "query", "description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)" }, { "name": "data-absent-reason", "type": "string", "in": "query", "description": "The reason why the expected value in the element Observation.value[x] is missing." }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "format": "date" }, { "name": "derived-from", "type": "string", "in": "query", "description": "Related measurements the observation is made from" }, { "name": "device", "type": "string", "in": "query", "description": "The Device that generated the observation data." }, { "name": "dna-variant", "type": "string", "in": "query", "description": "HGVS DNA variant" }, { "name": "encounter", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier" }, { "name": "focus", "type": "string", "in": "query", "description": "The focus of an observation when the focus is not the patient of record." }, { "name": "gene-amino-acid-change", "type": "string", "in": "query", "description": "HGNC gene symbol and HGVS Protein change" }, { "name": "gene-dnavariant", "type": "string", "in": "query", "description": "HGNC gene symbol and HGVS DNA Variant" }, { "name": "gene-identifier", "type": "string", "in": "query", "description": "HGNC gene symbol and identifier" }, { "name": "has-member", "type": "string", "in": "query", "description": "Related resource that belongs to the Observation group" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "method", "type": "string", "in": "query", "description": "The method used for the observation" }, { "name": "part-of", "type": "string", "in": "query", "description": "Part of referenced event" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "performer", "type": "string", "in": "query", "description": "Who performed the observation" }, { "name": "specimen", "type": "string", "in": "query", "description": "Specimen used for this observation" }, { "name": "status", "type": "string", "in": "query", "description": "The status of the observation" }, { "name": "subject", "type": "string", "in": "query", "description": "The subject that the observation is about" }, { "name": "value-concept", "type": "string", "in": "query", "description": "The value of the observation, if the value is a CodeableConcept" }, { "name": "value-date", "type": "string", "in": "query", "description": "The value of the observation, if the value is a date or period of time", "format": "date" }, { "name": "value-quantity", "type": "integer", "in": "query", "description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)" }, { "name": "value-string", "type": "string", "in": "query", "description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Observation" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Observation/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Smoking Status Observation Profile - Query for the Smoking Status of a Patient.\n - Smoking Status\n\n US Core Vital Signs Profile - Fetch Vital Signs for a Patient.\n - US Core Pediatric Head Occipital-frontal Circumference Percentile Profile\n - Head Occipital-frontal Circumference Percentile (Birth - 36 Months)\n - US Core Blood Pressure Profile\n - Diastolic & Systolic Blood Pressure\n - US Core BMI Profile\n - BMI Percentile (2-20 Years)\n - US Core Body Height Profile\n - Body Height\n - US Core Body Temperature Profile\n - Body Temperature\n - US Core Body Weight Profile\n - Body Weight\n - US Core Heart Rate Profile\n - Heart Rate\n - US Core Pediatric BMI for Age Observation Profile\n - BMI Percentile (2-20 Years)\n - US Core Pediatric Weight for Height Observation Profile\n - Weight-for-length Percentile (Birth - 36 Months)\n - US Core Pulse Oximetry Profile\n - Pulse Oximetry\n - Inhaled Oxygen Concentration\n - US Core Respiratory Rate Profile\n - Respiratory Rate", "tags": [ "Observation" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Observation" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Organization": { "get": { "description": "US Core Organization Profile - Query for Organization name of NPI.\n - Organization", "tags": [ "Organization" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "active", "type": "string", "in": "query", "description": "Is the Organization record active" }, { "name": "address", "type": "string", "in": "query", "description": "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text" }, { "name": "address-city", "type": "string", "in": "query", "description": "A city specified in an address" }, { "name": "address-country", "type": "string", "in": "query", "description": "A country specified in an address" }, { "name": "address-postalcode", "type": "string", "in": "query", "description": "A postal code specified in an address" }, { "name": "address-state", "type": "string", "in": "query", "description": "A state specified in an address" }, { "name": "address-use", "type": "string", "in": "query", "description": "A use code specified in an address" }, { "name": "endpoint", "type": "string", "in": "query", "description": "Technical endpoints providing access to services operated for the organization" }, { "name": "identifier", "type": "string", "in": "query", "description": "Any identifier for the organization (not the accreditation issuer's identifier)" }, { "name": "name", "type": "string", "in": "query", "description": "A portion of the organization's name or alias" }, { "name": "partof", "type": "string", "in": "query", "description": "An organization of which this organization forms a part" }, { "name": "phonetic", "type": "string", "in": "query", "description": "A portion of the organization's name using some kind of phonetic matching algorithm" }, { "name": "type", "type": "string", "in": "query", "description": "A code for the type of organization" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Organization" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Organization/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Organization Profile - Query for Organization name of NPI.\n - Organization", "tags": [ "Organization" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Organization" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Patient": { "get": { "description": "US Core Patient Profile - Query for Patient Demographic information.\n - FHIR Resource: Patient.name.given\n - First Name\n - Middle Name\n - FHIR Resource: Patient.name.family\n - Last Name\n - FHIR Resource: Patient.name\n - Previous Name\n - FHIR Resource: Patient.name.suffix\n - Suffix\n - FHIR Resource: US Core Birth Sex Extension\n - Sex (Assigned at Birth)\n - FHIR Resource: Patient.birthDate\n - Date of Birth\n - FHIR Resource: US Core Race Extension\n - Race\n - FHIR Resource: US Core Ethnicity Extension\n - Ethnicity\n - FHIR Resource: Patient.communication\n - Preferred Language\n - FHIR Resource: Patient.address\n - Address\n - FHIR Resource: Patient.telecom\n - Phone Number", "tags": [ "Patient" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "**Logical id of this artifact** \n**NOTE**: This US Core SearchParameter definition extends the usage context of the\n[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)\n - multipleAnd\n - multipleOr\n - comparator\n - modifier\n - chain" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "active", "type": "string", "in": "query", "description": "Whether the patient record is active" }, { "name": "address", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text" }, { "name": "address-city", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address" }, { "name": "address-country", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address" }, { "name": "address-postalcode", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address" }, { "name": "address-state", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address" }, { "name": "address-use", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address" }, { "name": "birthdate", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth", "format": "date" }, { "name": "death-date", "type": "string", "in": "query", "description": "The date of death has been provided and satisfies this search value", "format": "date" }, { "name": "deceased", "type": "string", "in": "query", "description": "This patient has been marked as deceased, or as a death date entered" }, { "name": "email", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact" }, { "name": "ethnicity", "type": "string", "in": "query", "description": "Returns patients with an ethnicity extension matching the specified code." }, { "name": "family", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name" }, { "name": "gender", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person" }, { "name": "general-practitioner", "type": "string", "in": "query", "description": "Patient's nominated general practitioner, not the organization that manages the record" }, { "name": "given", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name" }, { "name": "identifier", "type": "string", "in": "query", "description": "A patient identifier" }, { "name": "language", "type": "string", "in": "query", "description": "Language code (irrespective of use value)" }, { "name": "link", "type": "string", "in": "query", "description": "All patients linked to the given patient" }, { "name": "mothersMaidenName", "type": "string", "in": "query", "description": "Search based on patient's mother's maiden name" }, { "name": "name", "type": "string", "in": "query", "description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text" }, { "name": "organization", "type": "string", "in": "query", "description": "The organization that is the custodian of the patient record" }, { "name": "part-agree", "type": "string", "in": "query", "description": "Search by url for a participation agreement, which is stored in a DocumentReference" }, { "name": "phone", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact" }, { "name": "phonetic", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm" }, { "name": "race", "type": "string", "in": "query", "description": "Returns patients with a race extension matching the specified code." }, { "name": "telecom", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Patient" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Patient/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Patient Profile - Query for Patient Demographic information.\n - FHIR Resource: Patient.name.given\n - First Name\n - Middle Name\n - FHIR Resource: Patient.name.family\n - Last Name\n - FHIR Resource: Patient.name\n - Previous Name\n - FHIR Resource: Patient.name.suffix\n - Suffix\n - FHIR Resource: US Core Birth Sex Extension\n - Sex (Assigned at Birth)\n - FHIR Resource: Patient.birthDate\n - Date of Birth\n - FHIR Resource: US Core Race Extension\n - Race\n - FHIR Resource: US Core Ethnicity Extension\n - Ethnicity\n - FHIR Resource: Patient.communication\n - Preferred Language\n - FHIR Resource: Patient.address\n - Address\n - FHIR Resource: Patient.telecom\n - Phone Number", "tags": [ "Patient" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Patient" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Practitioner": { "get": { "description": "US Core Practitioner Profile - Query for a Practitioner by name of NPI.\n - Practitioner", "tags": [ "Practitioner" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "active", "type": "string", "in": "query", "description": "Whether the practitioner record is active" }, { "name": "address", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text" }, { "name": "address-city", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address" }, { "name": "address-country", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address" }, { "name": "address-postalcode", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address" }, { "name": "address-state", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address" }, { "name": "address-use", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address" }, { "name": "communication", "type": "string", "in": "query", "description": "One of the languages that the practitioner can communicate with" }, { "name": "email", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact" }, { "name": "family", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name" }, { "name": "gender", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person" }, { "name": "given", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name" }, { "name": "identifier", "type": "string", "in": "query", "description": "A practitioner's Identifier" }, { "name": "name", "type": "string", "in": "query", "description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text" }, { "name": "phone", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact" }, { "name": "phonetic", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm" }, { "name": "telecom", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Practitioner" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Practitioner/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Practitioner Profile - Query for a Practitioner by name of NPI.\n - Practitioner", "tags": [ "Practitioner" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Practitioner" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Procedure": { "get": { "description": "US Core Procedure Profile - Query for Procedures performed on a Patient.\n - Procedures", "tags": [ "Procedure" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "based-on", "type": "string", "in": "query", "description": "A request for this procedure" }, { "name": "category", "type": "string", "in": "query", "description": "Classification of the procedure" }, { "name": "code", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "date", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "format": "date" }, { "name": "encounter", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier" }, { "name": "identifier", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "instantiates-canonical", "type": "string", "in": "query", "description": "Instantiates FHIR protocol or definition" }, { "name": "instantiates-uri", "type": "string", "in": "query", "description": "Instantiates external protocol or definition" }, { "name": "location", "type": "string", "in": "query", "description": "Where the procedure happened" }, { "name": "part-of", "type": "string", "in": "query", "description": "Part of referenced event" }, { "name": "patient", "type": "string", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "performer", "type": "string", "in": "query", "description": "The reference to the practitioner" }, { "name": "reason-code", "type": "string", "in": "query", "description": "Coded reason procedure performed" }, { "name": "reason-reference", "type": "string", "in": "query", "description": "The justification that the procedure was performed" }, { "name": "status", "type": "string", "in": "query", "description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown" }, { "name": "subject", "type": "string", "in": "query", "description": "Search by subject" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Procedure" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Procedure/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Procedure Profile - Query for Procedures performed on a Patient.\n - Procedures", "tags": [ "Procedure" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Procedure" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Provenance": { "get": { "description": "US Core Provenance Profile - Query for the Provenance records associated with an Allergy, Problem, etc.\n - Author Time Stamp\n - Author Organization", "tags": [ "Provenance" ], "parameters": [ { "name": "_count", "type": "number", "in": "query", "description": "The number of resources returned per page" }, { "name": "_format", "type": "string", "in": "query", "description": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "in": "query", "description": "Enables querying a reverse chain" }, { "name": "_id", "type": "string", "in": "query", "description": "Search by resource identifier - e.g. same as the read interaction, but can return included resources" }, { "name": "_lastUpdated", "type": "string", "in": "query", "description": "When the resource version last changed", "format": "date" }, { "name": "_profile", "type": "string", "in": "query", "description": "Profiles this resource claims to conform to" }, { "name": "_security", "type": "string", "in": "query", "description": "Security Labels applied to this resource" }, { "name": "_source", "type": "string", "in": "query", "description": "Identifies where the resource comes from" }, { "name": "_tag", "type": "string", "in": "query", "description": "Tags applied to this resource" }, { "name": "agent", "type": "string", "in": "query", "description": "Who participated" }, { "name": "agent-role", "type": "string", "in": "query", "description": "What the agents role was" }, { "name": "agent-type", "type": "string", "in": "query", "description": "How the agent participated" }, { "name": "entity", "type": "string", "in": "query", "description": "Identity of entity" }, { "name": "location", "type": "string", "in": "query", "description": "Where the activity occurred, if relevant" }, { "name": "patient", "type": "string", "in": "query", "description": "Target Reference(s) (usually version specific)" }, { "name": "recorded", "type": "string", "in": "query", "description": "When the activity was recorded / updated", "format": "date" }, { "name": "signature-type", "type": "string", "in": "query", "description": "Indication of the reason the entity signed the object(s)" }, { "name": "target", "type": "string", "in": "query", "description": "Target Reference(s) (usually version specific)" }, { "name": "when", "type": "string", "in": "query", "description": "When the activity occurred", "format": "date" }, { "name": "_format", "in": "query", "type": "string", "x-consoleDefault": "application/json" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/Provenance" } } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/Provenance/{id}": { "parameters": [ { "in": "path", "required": true, "name": "id", "type": "string" } ], "get": { "description": "US Core Provenance Profile - Query for the Provenance records associated with an Allergy, Problem, etc.\n - Author Time Stamp\n - Author Organization", "tags": [ "Provenance" ], "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Provenance" } }, "400": { "description": "Bad request" }, "401": { "description": "Lacks valid authentication credentials" }, "403": { "description": "Access denied for this resource with the given credentials" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } } }, "info": { "description": "Fast Healthcare Interoperability Resources (FHIR, pronounced \"Fire\") defines a set of \"Resources\" that represent granular clinical concepts. The resources can be managed in isolation, or aggregated into complex documents. Technically, FHIR is designed for the web; the resources are based on simple XML or JSON structures, with an http-based RESTful protocol where each resource has predictable URL. Where possible, open internet standards are used for data representation.\n\n https://dl-sb-firely.azurewebsites.net\n\n [Service Base URL](./Endpoint.json)\n\n ## Client Application Requirements\n\n - Support for HL7 FHIR 4.0.1\n - US Core 4.0\n - Smart App Launch 1.0.0\n - Bulk Data Version 1.0.1\n\n SMART on FHIR applications will need to be registered by DataLink before they can be used. To start the registration process, please email supportticket@datalinksoftware.com with the subject titled \"FHIR API Client Registration\". Include in the email, the name of your application, contact information, and a short description of the application.\n\n DataLink will review your request and if you are approved you will receive an OAuth client_id to use on subsequent requests following the protocols specified in the official [SMART App Authorization Guide](https://docs.smarthealthit.org/authorization/). DataLink APIs are authenticated using the OAuth 2.0 protocol. All API requests must include an Authorization header with an Access Token of the form: Authorization: Bearer MY_JWT_TOKEN\n\n ## Terms and Conditions\n\n Relied Upon Software: Firely\n Firely Terms & Conditions: [Terms - SIMPLIFIER.NET](https://simplifier.net/terms)\n\n Confidential clients, such as web apps, which are capable of securely storing credentials will be issued a client_secret that may be used in conjunction with the client_id to form an authorization grant, which can be used to obtain refresh and access tokens. Our refresh tokens are long-lived and conform to Health IT criteria documented [here](https://www.healthit.gov/test-method/standardized-api-patient-and-population-services).\n\n Public applications, such as native apps, which are incapable of securely storing credentials will not be issued a client_secret. Instead, the authorization_code grant flow will be used to issue refresh tokens. As recommended in the OAuth 2.0 Authorization Framework spec, we require additional security measures when issuing refresh tokens to native applications. Specifically, we enforce refresh token rotation for all public applications, which is an auth flow in which each refresh token issued is valid for one use only. Whenever a public application uses a refresh token to request an access token, a new refresh token will be returned in the response body in addition to the requested access token.\n\n May require an annual cost for FHIR API capabilities utilizing Firely’s FHIR & Authentication servers to interact with SMART on FHIR applications. Please contact DataLink for specific pricing details.\n\n No other restrictions, limitations, obligations or cost.", "title": "DataLink FHIR API Documentation", "version": "v1" }, "host": "https://dl-sb-firely.azurewebsites.net", "schemes": [ "https" ], "basePath": "/", "tags": [ { "name": "CapabilityStatement" }, { "name": "AllergyIntolerance" }, { "name": "CarePlan" }, { "name": "CareTeam" }, { "name": "Condition" }, { "name": "Device" }, { "name": "DiagnosticReport" }, { "name": "DocumentReference" }, { "name": "Encounter" }, { "name": "Goal" }, { "name": "Immunization" }, { "name": "Location" }, { "name": "Medication" }, { "name": "MedicationRequest" }, { "name": "Observation" }, { "name": "Organization" }, { "name": "Patient" }, { "name": "Practitioner" }, { "name": "Procedure" }, { "name": "Provenance" } ] } }