Health NZ | Te Whatu Ora : API Standards FHIR Example Observation API (1.0.0)
Download OpenAPI specification:Download
An example FHIR API for recording and consuming FHIR Observation
data
Use cases include but are not limited to:
- Wearable input - e.g. smart watch recordings
- Vital signs measurements
Search all resources of type Observation based on a set of criteria
This base resource
Authorizations:
query Parameters
date | string <date> Example: date=2024-05-10 Search for Observations by |
patient | string Example: patient=ZXP7823 Search for Observations by |
encounter | string Example: encounter="545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0" Search for Observations by an associated |
identifier | string Example: identifier="545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0" Search for Observation resources by |
_count | number The maximum number of search results on a page. The server is not bound to return the number requested, but cannot return more |
category | string The classification of the type of observation |
performer | string Who performed the observation |
status | string The status of the observation |
subject | string The subject that the observation is about |
_lastUpdated | string([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9... When the resource version last changed |
header Parameters
object (Request-Context) Request context header definition |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "resourceType": "Bundle",
- "id": "50333364-b3bf-4e0c-b603-65b347997957",
- "meta": {
- "lastUpdated": "2024-05-22T00:01:53.301Z",
- "security": [
- {
- "code": "REDACTED",
- "display": "redacted"
}
]
}, - "type": "searchset",
- "total": 3,
- "link": [
- {
- "relation": "self",
}
], - "entry": [
- {
- "search": {
- "mode": "match"
}, - "resource": {
- "identifier": [
- {
- "use": "secondary",
- "value": "b848ab32-3057-4eed-b747-dbb9207690ce"
}
], - "code": {
- "coding": [
- {
- "code": "122869004",
- "display": "Measurement procedure (procedure)"
}
]
}, - "performer": [
- {
- "identifier": {
- "use": "official",
- "value": "99ZZFX"
}, - "display": "Dottie McStuffins",
- "type": "Practitioner"
}
], - "subject": {
- "identifier": {
- "use": "official",
- "value": "ZKC4633"
}, - "display": "Juppin WCDHB Pacer",
- "type": "Patient"
}, - "encounter": {
- "reference": "Encounter/a28f4181-f1bf-434b-bc5b-d2bf578e9997"
}, - "component": [
- {
- "code": {
}, - "valueQuantity": {
- "unit": "mmHg",
- "code": "mm[Hg]",
- "value": 73
}
}, - {
- "code": {
}, - "valueQuantity": {
- "unit": "mmHg",
- "code": "mm[Hg]",
- "value": 73
}
}, - {
- "valueQuantity": {
- "unit": "beats/minute",
- "code": "/min",
- "value": 44
}
}, - {
- "code": {
- "coding": [
- {
- "code": "80404-7",
- "display": "R-R interval.standard deviation (Heart rate variability)"
}
]
}, - "valueQuantity": {
- "unit": "milliseconds",
- "code": "ms",
- "value": 44
}
}, - {
- "code": {
}, - "valueQuantity": {
- "unit": "breaths/minute",
- "code": "/min",
- "value": 17
}
}, - {
- "code": {
- "coding": [
- {
- "code": "59408-5",
- "display": "Oxygen saturation in Arterial blood by Pulse oximetry"
}
]
}, - "valueQuantity": {
- "unit": "percent saturation",
- "code": "%{saturation}",
- "value": 96
}
}, - {
- "code": {
- "coding": [
]
}, - "valueQuantity": {
- "unit": "ScoreOf",
- "code": "{ScoreOf}",
- "value": 8
}
}, - {
- "valueCodeableConcept": {
- "coding": [
- {
- "code": "304753007",
- "display": "Perceived stress scale (assessment scale)"
}
], - "text": "normal"
},
}, - {
- "code": {
}, - "valueQuantity": {
- "unit": "degree Celsius",
- "code": "Cel",
- "value": 38
}
}, - {
- "valueQuantity": {
- "unit": "ScoreOf",
- "code": "{ScoreOf}",
- "value": 8
}
}
], - "meta": {
- "lastUpdated": "2024-05-19T19:58:15.137Z",
- "versionId": "1"
}, - "id": "f9aed1cf-c0e4-474b-9570-dd8259038fe5",
- "category": [
- {
- "coding": [
]
}
], - "issued": "2024-05-19T19:58:14.989Z",
- "basedOn": [
- {
- "reference": "ServiceRequest/0acd211b-6d8a-4e21-a034-d99ce475d216"
}
], - "resourceType": "Observation",
- "status": "final"
}
}, - {
- "search": {
- "mode": "match"
}, - "resource": {
- "identifier": [
- {
- "use": "secondary",
- "value": "22c50925-21fc-4d06-bff2-7f2a7592d7b3"
}
], - "code": {
- "coding": [
- {
- "code": "122869004",
- "display": "Measurement procedure (procedure)"
}
]
}, - "performer": [
- {
- "identifier": {
- "use": "official",
- "value": "99ZZFX"
}, - "display": "Dottie McStuffins",
- "type": "Practitioner"
}
], - "subject": {
- "identifier": {
- "use": "official",
- "value": "ZKC4633"
}, - "display": "Juppin WCDHB Pacer",
- "type": "Patient"
}, - "encounter": {
- "reference": "Encounter/cf693a3e-444b-4b05-a6cc-eacc89b5c85c"
}, - "component": [
- {
- "code": {
}, - "valueQuantity": {
- "unit": "mmHg",
- "code": "mm[Hg]",
- "value": 73
}
}, - {
- "code": {
}, - "valueQuantity": {
- "unit": "mmHg",
- "code": "mm[Hg]",
- "value": 73
}
}, - {
- "valueQuantity": {
- "unit": "beats/minute",
- "code": "/min",
- "value": 44
}
}, - {
- "code": {
- "coding": [
- {
- "code": "80404-7",
- "display": "R-R interval.standard deviation (Heart rate variability)"
}
]
}, - "valueQuantity": {
- "unit": "milliseconds",
- "code": "ms",
- "value": 44
}
}, - {
- "code": {
}, - "valueQuantity": {
- "unit": "breaths/minute",
- "code": "/min",
- "value": 17
}
}, - {
- "code": {
- "coding": [
- {
- "code": "59408-5",
- "display": "Oxygen saturation in Arterial blood by Pulse oximetry"
}
]
}, - "valueQuantity": {
- "unit": "percent saturation",
- "code": "%{saturation}",
- "value": 96
}
}, - {
- "code": {
- "coding": [
]
}, - "valueQuantity": {
- "unit": "ScoreOf",
- "code": "{ScoreOf}",
- "value": 8
}
}, - {
- "valueCodeableConcept": {
- "coding": [
- {
- "code": "304753007",
- "display": "Perceived stress scale (assessment scale)"
}
], - "text": "normal"
},
}, - {
- "code": {
}, - "valueQuantity": {
- "unit": "degree Celsius",
- "code": "Cel",
- "value": 38
}
}, - {
- "valueQuantity": {
- "unit": "ScoreOf",
- "code": "{ScoreOf}",
- "value": 8
}
}
], - "meta": {
- "lastUpdated": "2024-05-19T19:58:07.503Z",
- "versionId": "1"
}, - "id": "34a66bca-6de0-4ad4-a8cf-7288902f3832",
- "category": [
- {
- "coding": [
]
}
], - "issued": "2024-05-19T19:58:07.208Z",
- "basedOn": [
- {
- "reference": "ServiceRequest/0acd211b-6d8a-4e21-a034-d99ce475d216"
}
], - "resourceType": "Observation",
- "status": "final"
}
}
]
}
Read the current state of the resource
Retrieve an instance of an observation resource using the resource's unique id
Authorizations:
path Parameters
rid required | string Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0" id of the resource (=Resource.id) |
query Parameters
_summary | string Enum: "true" "text" "data" "count" "false" Requests the server to return a designated subset of the resource |
_elements | Array of any <string> [ items <string > ] Requests the server to return a collection of elements from the resource |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "resourceType": "Observation",
- "id": "string",
- "meta": {
- "id": "string",
- "extension": [
- {
- "id": "string",
- "extension": [
- null
], - "url": "string",
- "_url": {
- "id": "string",
- "extension": [
- null
]
}, - "valueBase64Binary": "string",
- "_valueBase64Binary": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueCanonical": "string",
- "_valueCanonical": { },
- "valueCode": "string",
- "_valueCode": { },
- "valueDate": "string",
- "_valueDate": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valueDecimal": 0,
- "_valueDecimal": { },
- "valueId": "string",
- "_valueId": { },
- "valueInstant": "string",
- "_valueInstant": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueMarkdown": "string",
- "_valueMarkdown": { },
- "valueOid": "string",
- "_valueOid": { },
- "valuePositiveInt": 0,
- "_valuePositiveInt": { },
- "valueString": "string",
- "_valueString": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueUnsignedInt": 0,
- "_valueUnsignedInt": { },
- "valueUri": "string",
- "_valueUri": { },
- "valueUrl": "string",
- "_valueUrl": { },
- "valueUuid": "string",
- "_valueUuid": { },
- "valueAddress": {
- "id": "string",
- "extension": [
- null
], - "use": "home",
- "_use": { },
- "type": "postal",
- "_type": { },
- "text": "string",
- "_text": { },
- "line": [
- "string"
], - "_line": [
- { }
], - "city": "string",
- "_city": { },
- "district": "string",
- "_district": { },
- "state": "string",
- "_state": { },
- "postalCode": "string",
- "_postalCode": { },
- "country": "string",
- "_country": { },
- "period": {
- "id": "string",
- "extension": [
- null
], - "start": "string",
- "_start": { },
- "end": "string",
- "_end": { }
}
}, - "valueAge": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueAnnotation": {
- "id": "string",
- "extension": [
- null
], - "authorReference": {
- "id": "string",
- "extension": [
- null
], - "reference": "string",
- "_reference": { },
- "type": "string",
- "_type": { },
- "identifier": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "type": {
- "id": "string",
- "extension": [
- null
], - "coding": [
- {
- "id": null,
- "extension": [ ],
- "system": null,
- "_system": { },
- "version": null,
- "_version": { },
- "code": null,
- "_code": { },
- "display": null,
- "_display": { },
- "userSelected": null,
- "_userSelected": { }
}
], - "text": "string",
- "_text": { }
}, - "system": "string",
- "_system": { },
- "value": "string",
- "_value": { },
- "period": { },
- "assigner": { }
}, - "display": "string",
- "_display": { }
}, - "authorString": "string",
- "_authorString": { },
- "time": "string",
- "_time": { },
- "text": "string",
- "_text": { }
}, - "valueAttachment": {
- "id": "string",
- "extension": [
- null
], - "contentType": "string",
- "_contentType": { },
- "language": "string",
- "_language": { },
- "data": "string",
- "_data": { },
- "url": "string",
- "_url": { },
- "size": 0,
- "_size": { },
- "hash": "string",
- "_hash": { },
- "title": "string",
- "_title": { },
- "creation": "string",
- "_creation": { }
}, - "valueCodeableConcept": { },
- "valueCoding": { },
- "valueContactPoint": {
- "id": "string",
- "extension": [
- null
], - "system": "phone",
- "_system": { },
- "value": "string",
- "_value": { },
- "use": "home",
- "_use": { },
- "rank": 0,
- "_rank": { },
- "period": { }
}, - "valueCount": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDistance": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDuration": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueHumanName": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "text": "string",
- "_text": { },
- "family": "string",
- "_family": { },
- "given": [
- null
], - "_given": [
- null
], - "prefix": [
- null
], - "_prefix": [
- null
], - "suffix": [
- null
], - "_suffix": [
- null
], - "period": { }
}, - "valueIdentifier": { },
- "valueMoney": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "currency": "string",
- "_currency": { }
}, - "valuePeriod": { },
- "valueQuantity": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueRange": {
- "id": "string",
- "extension": [
- null
], - "low": { },
- "high": { }
}, - "valueRatio": {
- "id": "string",
- "extension": [
- null
], - "numerator": { },
- "denominator": { }
}, - "valueReference": { },
- "valueSampledData": {
- "id": "string",
- "extension": [
- null
], - "origin": { },
- "period": 0,
- "_period": { },
- "factor": 0,
- "_factor": { },
- "lowerLimit": 0,
- "_lowerLimit": { },
- "upperLimit": 0,
- "_upperLimit": { },
- "dimensions": 0,
- "_dimensions": { },
- "data": "string",
- "_data": { }
}, - "valueSignature": {
- "id": "string",
- "extension": [
- null
], - "type": [
- null
], - "when": "string",
- "_when": { },
- "who": { },
- "onBehalfOf": { },
- "targetFormat": "string",
- "_targetFormat": { },
- "sigFormat": "string",
- "_sigFormat": { },
- "data": "string",
- "_data": { }
}, - "valueTiming": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "event": [
- "string"
], - "_event": [
- null
], - "repeat": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "boundsDuration": { },
- "boundsRange": { },
- "boundsPeriod": { },
- "count": 0,
- "_count": { },
- "countMax": 0,
- "_countMax": { },
- "duration": 0,
- "_duration": { },
- "durationMax": 0,
- "_durationMax": { },
- "durationUnit": "s",
- "_durationUnit": { },
- "frequency": 0,
- "_frequency": { },
- "frequencyMax": 0,
- "_frequencyMax": { },
- "period": 0,
- "_period": { },
- "periodMax": 0,
- "_periodMax": { },
- "periodUnit": "s",
- "_periodUnit": { },
- "dayOfWeek": [
- "string"
], - "_dayOfWeek": [
- null
], - "timeOfDay": [
- "string"
], - "_timeOfDay": [
- null
], - "when": [
- "MORN"
], - "_when": [
- null
], - "offset": 0,
- "_offset": { }
}, - "code": { }
}, - "valueContactDetail": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "telecom": [
- { }
]
}, - "valueContributor": {
- "id": "string",
- "extension": [
- null
], - "type": "author",
- "_type": { },
- "name": "string",
- "_name": { },
- "contact": [
- { }
]
}, - "valueDataRequirement": {
- "id": "string",
- "extension": [
- null
], - "type": "string",
- "_type": { },
- "profile": [
- "string"
], - "subjectCodeableConcept": { },
- "subjectReference": { },
- "mustSupport": [
- null
], - "_mustSupport": [
- null
], - "codeFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueSet": "string",
- "code": [
- null
]
}
], - "dateFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "valueDuration": { }
}
], - "limit": 0,
- "_limit": { },
- "sort": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "direction": "ascending",
- "_direction": { }
}
]
}, - "valueExpression": {
- "id": "string",
- "extension": [
- null
], - "description": "string",
- "_description": { },
- "name": "string",
- "_name": { },
- "language": "text/cql",
- "_language": { },
- "expression": "string",
- "_expression": { },
- "reference": "string",
- "_reference": { }
}, - "valueParameterDefinition": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "use": "string",
- "_use": { },
- "min": 0,
- "_min": { },
- "max": "string",
- "_max": { },
- "documentation": "string",
- "_documentation": { },
- "type": "string",
- "_type": { },
- "profile": "string"
}, - "valueRelatedArtifact": {
- "id": "string",
- "extension": [
- null
], - "type": "documentation",
- "_type": { },
- "label": "string",
- "_label": { },
- "display": "string",
- "_display": { },
- "citation": "string",
- "_citation": { },
- "url": "string",
- "_url": { },
- "document": { },
- "resource": "string"
}, - "valueTriggerDefinition": {
- "id": "string",
- "extension": [
- null
], - "type": "named-event",
- "_type": { },
- "name": "string",
- "_name": { },
- "timingTiming": { },
- "timingReference": { },
- "timingDate": "string",
- "_timingDate": { },
- "timingDateTime": "string",
- "_timingDateTime": { },
- "data": [
- { }
], - "condition": { }
}, - "valueUsageContext": {
- "id": "string",
- "extension": [
- null
], - "code": { },
- "valueCodeableConcept": { },
- "valueQuantity": { },
- "valueRange": { },
- "valueReference": { }
}, - "valueDosage": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "sequence": 0,
- "_sequence": { },
- "text": "string",
- "_text": { },
- "additionalInstruction": [
- { }
], - "patientInstruction": "string",
- "_patientInstruction": { },
- "timing": { },
- "asNeededBoolean": true,
- "_asNeededBoolean": { },
- "asNeededCodeableConcept": { },
- "site": { },
- "route": { },
- "method": { },
- "doseAndRate": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "type": { },
- "doseRange": { },
- "doseQuantity": { },
- "rateRatio": { },
- "rateRange": { },
- "rateQuantity": { }
}
], - "maxDosePerPeriod": { },
- "maxDosePerAdministration": { },
- "maxDosePerLifetime": { }
}, - "valueMeta": { }
}
], - "versionId": "string",
- "_versionId": { },
- "lastUpdated": "string",
- "_lastUpdated": { },
- "source": "string",
- "_source": { },
- "profile": [
- null
], - "security": [
- null
], - "tag": [
- null
]
}, - "implicitRules": "string",
- "_implicitRules": { },
- "language": "string",
- "_language": { },
- "text": {
- "id": "string",
- "extension": [
- null
], - "status": "generated",
- "_status": { },
- "div": null
}, - "extension": [
- null
], - "modifierExtension": [
- null
], - "identifier": [
- { }
], - "basedOn": [
- { }
], - "partOf": [
- null
], - "status": "registered",
- "_status": { },
- "category": [
- null
], - "code": { },
- "subject": { },
- "focus": [
- null
], - "encounter": { },
- "effectiveDateTime": "string",
- "_effectiveDateTime": { },
- "effectivePeriod": { },
- "effectiveTiming": { },
- "effectiveInstant": "string",
- "_effectiveInstant": { },
- "issued": "string",
- "_issued": { },
- "performer": [
- null
], - "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "note": [
- { }
], - "bodySite": { },
- "method": { },
- "specimen": { },
- "device": { },
- "referenceRange": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "low": { },
- "high": { },
- "type": { },
- "appliesTo": [
- null
], - "age": { },
- "text": "string",
- "_text": { }
}
], - "hasMember": [
- null
], - "derivedFrom": [
- null
], - "component": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "code": { },
- "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "referenceRange": [
- null
]
}
]
}
Read a past state of the resource
Read the past state of a resource using the resource's unique id and a specific version
Authorizations:
path Parameters
rid required | string Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0" id of the resource (=Resource.id) |
hid required | string <uuid> Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0" id of the history entry (=Resource.meta.versionId) |
query Parameters
_summary | string Enum: "true" "text" "data" "count" "false" Requests the server to return a designated subset of the resource |
_elements | Array of any <string> [ items <string > ] Requests the server to return a collection of elements from the resource |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "resourceType": "Observation",
- "id": "string",
- "meta": {
- "id": "string",
- "extension": [
- {
- "id": "string",
- "extension": [
- null
], - "url": "string",
- "_url": {
- "id": "string",
- "extension": [
- null
]
}, - "valueBase64Binary": "string",
- "_valueBase64Binary": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueCanonical": "string",
- "_valueCanonical": { },
- "valueCode": "string",
- "_valueCode": { },
- "valueDate": "string",
- "_valueDate": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valueDecimal": 0,
- "_valueDecimal": { },
- "valueId": "string",
- "_valueId": { },
- "valueInstant": "string",
- "_valueInstant": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueMarkdown": "string",
- "_valueMarkdown": { },
- "valueOid": "string",
- "_valueOid": { },
- "valuePositiveInt": 0,
- "_valuePositiveInt": { },
- "valueString": "string",
- "_valueString": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueUnsignedInt": 0,
- "_valueUnsignedInt": { },
- "valueUri": "string",
- "_valueUri": { },
- "valueUrl": "string",
- "_valueUrl": { },
- "valueUuid": "string",
- "_valueUuid": { },
- "valueAddress": {
- "id": "string",
- "extension": [
- null
], - "use": "home",
- "_use": { },
- "type": "postal",
- "_type": { },
- "text": "string",
- "_text": { },
- "line": [
- "string"
], - "_line": [
- { }
], - "city": "string",
- "_city": { },
- "district": "string",
- "_district": { },
- "state": "string",
- "_state": { },
- "postalCode": "string",
- "_postalCode": { },
- "country": "string",
- "_country": { },
- "period": {
- "id": "string",
- "extension": [
- null
], - "start": "string",
- "_start": { },
- "end": "string",
- "_end": { }
}
}, - "valueAge": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueAnnotation": {
- "id": "string",
- "extension": [
- null
], - "authorReference": {
- "id": "string",
- "extension": [
- null
], - "reference": "string",
- "_reference": { },
- "type": "string",
- "_type": { },
- "identifier": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "type": {
- "id": "string",
- "extension": [
- null
], - "coding": [
- {
- "id": null,
- "extension": [ ],
- "system": null,
- "_system": { },
- "version": null,
- "_version": { },
- "code": null,
- "_code": { },
- "display": null,
- "_display": { },
- "userSelected": null,
- "_userSelected": { }
}
], - "text": "string",
- "_text": { }
}, - "system": "string",
- "_system": { },
- "value": "string",
- "_value": { },
- "period": { },
- "assigner": { }
}, - "display": "string",
- "_display": { }
}, - "authorString": "string",
- "_authorString": { },
- "time": "string",
- "_time": { },
- "text": "string",
- "_text": { }
}, - "valueAttachment": {
- "id": "string",
- "extension": [
- null
], - "contentType": "string",
- "_contentType": { },
- "language": "string",
- "_language": { },
- "data": "string",
- "_data": { },
- "url": "string",
- "_url": { },
- "size": 0,
- "_size": { },
- "hash": "string",
- "_hash": { },
- "title": "string",
- "_title": { },
- "creation": "string",
- "_creation": { }
}, - "valueCodeableConcept": { },
- "valueCoding": { },
- "valueContactPoint": {
- "id": "string",
- "extension": [
- null
], - "system": "phone",
- "_system": { },
- "value": "string",
- "_value": { },
- "use": "home",
- "_use": { },
- "rank": 0,
- "_rank": { },
- "period": { }
}, - "valueCount": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDistance": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDuration": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueHumanName": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "text": "string",
- "_text": { },
- "family": "string",
- "_family": { },
- "given": [
- null
], - "_given": [
- null
], - "prefix": [
- null
], - "_prefix": [
- null
], - "suffix": [
- null
], - "_suffix": [
- null
], - "period": { }
}, - "valueIdentifier": { },
- "valueMoney": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "currency": "string",
- "_currency": { }
}, - "valuePeriod": { },
- "valueQuantity": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueRange": {
- "id": "string",
- "extension": [
- null
], - "low": { },
- "high": { }
}, - "valueRatio": {
- "id": "string",
- "extension": [
- null
], - "numerator": { },
- "denominator": { }
}, - "valueReference": { },
- "valueSampledData": {
- "id": "string",
- "extension": [
- null
], - "origin": { },
- "period": 0,
- "_period": { },
- "factor": 0,
- "_factor": { },
- "lowerLimit": 0,
- "_lowerLimit": { },
- "upperLimit": 0,
- "_upperLimit": { },
- "dimensions": 0,
- "_dimensions": { },
- "data": "string",
- "_data": { }
}, - "valueSignature": {
- "id": "string",
- "extension": [
- null
], - "type": [
- null
], - "when": "string",
- "_when": { },
- "who": { },
- "onBehalfOf": { },
- "targetFormat": "string",
- "_targetFormat": { },
- "sigFormat": "string",
- "_sigFormat": { },
- "data": "string",
- "_data": { }
}, - "valueTiming": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "event": [
- "string"
], - "_event": [
- null
], - "repeat": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "boundsDuration": { },
- "boundsRange": { },
- "boundsPeriod": { },
- "count": 0,
- "_count": { },
- "countMax": 0,
- "_countMax": { },
- "duration": 0,
- "_duration": { },
- "durationMax": 0,
- "_durationMax": { },
- "durationUnit": "s",
- "_durationUnit": { },
- "frequency": 0,
- "_frequency": { },
- "frequencyMax": 0,
- "_frequencyMax": { },
- "period": 0,
- "_period": { },
- "periodMax": 0,
- "_periodMax": { },
- "periodUnit": "s",
- "_periodUnit": { },
- "dayOfWeek": [
- "string"
], - "_dayOfWeek": [
- null
], - "timeOfDay": [
- "string"
], - "_timeOfDay": [
- null
], - "when": [
- "MORN"
], - "_when": [
- null
], - "offset": 0,
- "_offset": { }
}, - "code": { }
}, - "valueContactDetail": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "telecom": [
- { }
]
}, - "valueContributor": {
- "id": "string",
- "extension": [
- null
], - "type": "author",
- "_type": { },
- "name": "string",
- "_name": { },
- "contact": [
- { }
]
}, - "valueDataRequirement": {
- "id": "string",
- "extension": [
- null
], - "type": "string",
- "_type": { },
- "profile": [
- "string"
], - "subjectCodeableConcept": { },
- "subjectReference": { },
- "mustSupport": [
- null
], - "_mustSupport": [
- null
], - "codeFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueSet": "string",
- "code": [
- null
]
}
], - "dateFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "valueDuration": { }
}
], - "limit": 0,
- "_limit": { },
- "sort": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "direction": "ascending",
- "_direction": { }
}
]
}, - "valueExpression": {
- "id": "string",
- "extension": [
- null
], - "description": "string",
- "_description": { },
- "name": "string",
- "_name": { },
- "language": "text/cql",
- "_language": { },
- "expression": "string",
- "_expression": { },
- "reference": "string",
- "_reference": { }
}, - "valueParameterDefinition": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "use": "string",
- "_use": { },
- "min": 0,
- "_min": { },
- "max": "string",
- "_max": { },
- "documentation": "string",
- "_documentation": { },
- "type": "string",
- "_type": { },
- "profile": "string"
}, - "valueRelatedArtifact": {
- "id": "string",
- "extension": [
- null
], - "type": "documentation",
- "_type": { },
- "label": "string",
- "_label": { },
- "display": "string",
- "_display": { },
- "citation": "string",
- "_citation": { },
- "url": "string",
- "_url": { },
- "document": { },
- "resource": "string"
}, - "valueTriggerDefinition": {
- "id": "string",
- "extension": [
- null
], - "type": "named-event",
- "_type": { },
- "name": "string",
- "_name": { },
- "timingTiming": { },
- "timingReference": { },
- "timingDate": "string",
- "_timingDate": { },
- "timingDateTime": "string",
- "_timingDateTime": { },
- "data": [
- { }
], - "condition": { }
}, - "valueUsageContext": {
- "id": "string",
- "extension": [
- null
], - "code": { },
- "valueCodeableConcept": { },
- "valueQuantity": { },
- "valueRange": { },
- "valueReference": { }
}, - "valueDosage": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "sequence": 0,
- "_sequence": { },
- "text": "string",
- "_text": { },
- "additionalInstruction": [
- { }
], - "patientInstruction": "string",
- "_patientInstruction": { },
- "timing": { },
- "asNeededBoolean": true,
- "_asNeededBoolean": { },
- "asNeededCodeableConcept": { },
- "site": { },
- "route": { },
- "method": { },
- "doseAndRate": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "type": { },
- "doseRange": { },
- "doseQuantity": { },
- "rateRatio": { },
- "rateRange": { },
- "rateQuantity": { }
}
], - "maxDosePerPeriod": { },
- "maxDosePerAdministration": { },
- "maxDosePerLifetime": { }
}, - "valueMeta": { }
}
], - "versionId": "string",
- "_versionId": { },
- "lastUpdated": "string",
- "_lastUpdated": { },
- "source": "string",
- "_source": { },
- "profile": [
- null
], - "security": [
- null
], - "tag": [
- null
]
}, - "implicitRules": "string",
- "_implicitRules": { },
- "language": "string",
- "_language": { },
- "text": {
- "id": "string",
- "extension": [
- null
], - "status": "generated",
- "_status": { },
- "div": null
}, - "extension": [
- null
], - "modifierExtension": [
- null
], - "identifier": [
- { }
], - "basedOn": [
- { }
], - "partOf": [
- null
], - "status": "registered",
- "_status": { },
- "category": [
- null
], - "code": { },
- "subject": { },
- "focus": [
- null
], - "encounter": { },
- "effectiveDateTime": "string",
- "_effectiveDateTime": { },
- "effectivePeriod": { },
- "effectiveTiming": { },
- "effectiveInstant": "string",
- "_effectiveInstant": { },
- "issued": "string",
- "_issued": { },
- "performer": [
- null
], - "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "note": [
- { }
], - "bodySite": { },
- "method": { },
- "specimen": { },
- "device": { },
- "referenceRange": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "low": { },
- "high": { },
- "type": { },
- "appliesTo": [
- null
], - "age": { },
- "text": "string",
- "_text": { }
}
], - "hasMember": [
- null
], - "derivedFrom": [
- null
], - "component": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "code": { },
- "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "referenceRange": [
- null
]
}
]
}
Create a new resource
Create a new Observation resource
Authorizations:
query Parameters
_summary | string Enum: "true" "text" "data" "count" "false" Requests the server to return a designated subset of the resource |
_elements | Array of any <string> [ items <string > ] Requests the server to return a collection of elements from the resource |
header Parameters
object (Request-Context) Request context header definition |
Request Body schema: application/fhir+jsonrequired
The new state of the resource
resourceType required | any Value: "Observation" This is a Observation resource |
id | string^[A-Za-z0-9\-\.]{1,64}$ The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
object The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | string^\S*$ String of characters used to identify a name or a resource |
object Base definition for all elements in a resource. | |
language | string^[^\s]+(\s[^\s]+)*$ A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents |
object Base definition for all elements in a resource. | |
object A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
extension | Array of any May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | Array of any May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Array of objects A unique identifier assigned to this observation. | |
Array of objects A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. | |
partOf | Array of any A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
status | any Enum: "registered" "preliminary" "final" "amended" "corrected" "cancelled" "entered-in-error" "unknown" The status of the result value. |
object Base definition for all elements in a resource. | |
category | Array of any A code that classifies the general type of observation being made. |
required | object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
object A reference from one resource to another. | |
focus | Array of any The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
object A reference from one resource to another. | |
effectiveDateTime | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. |
object Base definition for all elements in a resource. | |
object A time period defined by a start and end date and optionally time. | |
object Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out. | |
effectiveInstant | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. |
object Base definition for all elements in a resource. | |
issued | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. |
object Base definition for all elements in a resource. | |
performer | Array of any Who was responsible for asserting the observed value as "true". |
object A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. | |
object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |
valueString | string^[ \r\n\t\S]+$ The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
valueBoolean | boolean^true|false$ The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
valueInteger | number^-?([0]|([1-9][0-9]*))$ The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
object The information determined as a result of making the observation, if the information has a simple value. | |
object The information determined as a result of making the observation, if the information has a simple value. | |
object The information determined as a result of making the observation, if the information has a simple value. | |
valueTime | string^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60... The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
valueDateTime | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
object A time period defined by a start and end date and optionally time. | |
object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |
interpretation | Array of any A categorical assessment of an observation value. For example, high, low, normal. |
Array of objects Comments about the observation or the results. | |
object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |
object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |
object A reference from one resource to another. | |
object A reference from one resource to another. | |
Array of objects Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two | |
hasMember | Array of any This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
derivedFrom | Array of any The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
Array of objects Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Responses
Request samples
- Payload
{- "resourceType": "Observation",
- "id": "string",
- "meta": {
- "id": "string",
- "extension": [
- {
- "id": "string",
- "extension": [
- null
], - "url": "string",
- "_url": {
- "id": "string",
- "extension": [
- null
]
}, - "valueBase64Binary": "string",
- "_valueBase64Binary": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueCanonical": "string",
- "_valueCanonical": { },
- "valueCode": "string",
- "_valueCode": { },
- "valueDate": "string",
- "_valueDate": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valueDecimal": 0,
- "_valueDecimal": { },
- "valueId": "string",
- "_valueId": { },
- "valueInstant": "string",
- "_valueInstant": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueMarkdown": "string",
- "_valueMarkdown": { },
- "valueOid": "string",
- "_valueOid": { },
- "valuePositiveInt": 0,
- "_valuePositiveInt": { },
- "valueString": "string",
- "_valueString": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueUnsignedInt": 0,
- "_valueUnsignedInt": { },
- "valueUri": "string",
- "_valueUri": { },
- "valueUrl": "string",
- "_valueUrl": { },
- "valueUuid": "string",
- "_valueUuid": { },
- "valueAddress": {
- "id": "string",
- "extension": [
- null
], - "use": "home",
- "_use": { },
- "type": "postal",
- "_type": { },
- "text": "string",
- "_text": { },
- "line": [
- "string"
], - "_line": [
- { }
], - "city": "string",
- "_city": { },
- "district": "string",
- "_district": { },
- "state": "string",
- "_state": { },
- "postalCode": "string",
- "_postalCode": { },
- "country": "string",
- "_country": { },
- "period": {
- "id": "string",
- "extension": [
- null
], - "start": "string",
- "_start": { },
- "end": "string",
- "_end": { }
}
}, - "valueAge": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueAnnotation": {
- "id": "string",
- "extension": [
- null
], - "authorReference": {
- "id": "string",
- "extension": [
- null
], - "reference": "string",
- "_reference": { },
- "type": "string",
- "_type": { },
- "identifier": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "type": {
- "id": "string",
- "extension": [
- null
], - "coding": [
- {
- "id": null,
- "extension": [ ],
- "system": null,
- "_system": { },
- "version": null,
- "_version": { },
- "code": null,
- "_code": { },
- "display": null,
- "_display": { },
- "userSelected": null,
- "_userSelected": { }
}
], - "text": "string",
- "_text": { }
}, - "system": "string",
- "_system": { },
- "value": "string",
- "_value": { },
- "period": { },
- "assigner": { }
}, - "display": "string",
- "_display": { }
}, - "authorString": "string",
- "_authorString": { },
- "time": "string",
- "_time": { },
- "text": "string",
- "_text": { }
}, - "valueAttachment": {
- "id": "string",
- "extension": [
- null
], - "contentType": "string",
- "_contentType": { },
- "language": "string",
- "_language": { },
- "data": "string",
- "_data": { },
- "url": "string",
- "_url": { },
- "size": 0,
- "_size": { },
- "hash": "string",
- "_hash": { },
- "title": "string",
- "_title": { },
- "creation": "string",
- "_creation": { }
}, - "valueCodeableConcept": { },
- "valueCoding": { },
- "valueContactPoint": {
- "id": "string",
- "extension": [
- null
], - "system": "phone",
- "_system": { },
- "value": "string",
- "_value": { },
- "use": "home",
- "_use": { },
- "rank": 0,
- "_rank": { },
- "period": { }
}, - "valueCount": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDistance": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDuration": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueHumanName": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "text": "string",
- "_text": { },
- "family": "string",
- "_family": { },
- "given": [
- null
], - "_given": [
- null
], - "prefix": [
- null
], - "_prefix": [
- null
], - "suffix": [
- null
], - "_suffix": [
- null
], - "period": { }
}, - "valueIdentifier": { },
- "valueMoney": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "currency": "string",
- "_currency": { }
}, - "valuePeriod": { },
- "valueQuantity": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueRange": {
- "id": "string",
- "extension": [
- null
], - "low": { },
- "high": { }
}, - "valueRatio": {
- "id": "string",
- "extension": [
- null
], - "numerator": { },
- "denominator": { }
}, - "valueReference": { },
- "valueSampledData": {
- "id": "string",
- "extension": [
- null
], - "origin": { },
- "period": 0,
- "_period": { },
- "factor": 0,
- "_factor": { },
- "lowerLimit": 0,
- "_lowerLimit": { },
- "upperLimit": 0,
- "_upperLimit": { },
- "dimensions": 0,
- "_dimensions": { },
- "data": "string",
- "_data": { }
}, - "valueSignature": {
- "id": "string",
- "extension": [
- null
], - "type": [
- null
], - "when": "string",
- "_when": { },
- "who": { },
- "onBehalfOf": { },
- "targetFormat": "string",
- "_targetFormat": { },
- "sigFormat": "string",
- "_sigFormat": { },
- "data": "string",
- "_data": { }
}, - "valueTiming": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "event": [
- "string"
], - "_event": [
- null
], - "repeat": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "boundsDuration": { },
- "boundsRange": { },
- "boundsPeriod": { },
- "count": 0,
- "_count": { },
- "countMax": 0,
- "_countMax": { },
- "duration": 0,
- "_duration": { },
- "durationMax": 0,
- "_durationMax": { },
- "durationUnit": "s",
- "_durationUnit": { },
- "frequency": 0,
- "_frequency": { },
- "frequencyMax": 0,
- "_frequencyMax": { },
- "period": 0,
- "_period": { },
- "periodMax": 0,
- "_periodMax": { },
- "periodUnit": "s",
- "_periodUnit": { },
- "dayOfWeek": [
- "string"
], - "_dayOfWeek": [
- null
], - "timeOfDay": [
- "string"
], - "_timeOfDay": [
- null
], - "when": [
- "MORN"
], - "_when": [
- null
], - "offset": 0,
- "_offset": { }
}, - "code": { }
}, - "valueContactDetail": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "telecom": [
- { }
]
}, - "valueContributor": {
- "id": "string",
- "extension": [
- null
], - "type": "author",
- "_type": { },
- "name": "string",
- "_name": { },
- "contact": [
- { }
]
}, - "valueDataRequirement": {
- "id": "string",
- "extension": [
- null
], - "type": "string",
- "_type": { },
- "profile": [
- "string"
], - "subjectCodeableConcept": { },
- "subjectReference": { },
- "mustSupport": [
- null
], - "_mustSupport": [
- null
], - "codeFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueSet": "string",
- "code": [
- null
]
}
], - "dateFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "valueDuration": { }
}
], - "limit": 0,
- "_limit": { },
- "sort": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "direction": "ascending",
- "_direction": { }
}
]
}, - "valueExpression": {
- "id": "string",
- "extension": [
- null
], - "description": "string",
- "_description": { },
- "name": "string",
- "_name": { },
- "language": "text/cql",
- "_language": { },
- "expression": "string",
- "_expression": { },
- "reference": "string",
- "_reference": { }
}, - "valueParameterDefinition": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "use": "string",
- "_use": { },
- "min": 0,
- "_min": { },
- "max": "string",
- "_max": { },
- "documentation": "string",
- "_documentation": { },
- "type": "string",
- "_type": { },
- "profile": "string"
}, - "valueRelatedArtifact": {
- "id": "string",
- "extension": [
- null
], - "type": "documentation",
- "_type": { },
- "label": "string",
- "_label": { },
- "display": "string",
- "_display": { },
- "citation": "string",
- "_citation": { },
- "url": "string",
- "_url": { },
- "document": { },
- "resource": "string"
}, - "valueTriggerDefinition": {
- "id": "string",
- "extension": [
- null
], - "type": "named-event",
- "_type": { },
- "name": "string",
- "_name": { },
- "timingTiming": { },
- "timingReference": { },
- "timingDate": "string",
- "_timingDate": { },
- "timingDateTime": "string",
- "_timingDateTime": { },
- "data": [
- { }
], - "condition": { }
}, - "valueUsageContext": {
- "id": "string",
- "extension": [
- null
], - "code": { },
- "valueCodeableConcept": { },
- "valueQuantity": { },
- "valueRange": { },
- "valueReference": { }
}, - "valueDosage": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "sequence": 0,
- "_sequence": { },
- "text": "string",
- "_text": { },
- "additionalInstruction": [
- { }
], - "patientInstruction": "string",
- "_patientInstruction": { },
- "timing": { },
- "asNeededBoolean": true,
- "_asNeededBoolean": { },
- "asNeededCodeableConcept": { },
- "site": { },
- "route": { },
- "method": { },
- "doseAndRate": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "type": { },
- "doseRange": { },
- "doseQuantity": { },
- "rateRatio": { },
- "rateRange": { },
- "rateQuantity": { }
}
], - "maxDosePerPeriod": { },
- "maxDosePerAdministration": { },
- "maxDosePerLifetime": { }
}, - "valueMeta": { }
}
], - "versionId": "string",
- "_versionId": { },
- "lastUpdated": "string",
- "_lastUpdated": { },
- "source": "string",
- "_source": { },
- "profile": [
- null
], - "security": [
- null
], - "tag": [
- null
]
}, - "implicitRules": "string",
- "_implicitRules": { },
- "language": "string",
- "_language": { },
- "text": {
- "id": "string",
- "extension": [
- null
], - "status": "generated",
- "_status": { },
- "div": null
}, - "extension": [
- null
], - "modifierExtension": [
- null
], - "identifier": [
- { }
], - "basedOn": [
- { }
], - "partOf": [
- null
], - "status": "registered",
- "_status": { },
- "category": [
- null
], - "code": { },
- "subject": { },
- "focus": [
- null
], - "encounter": { },
- "effectiveDateTime": "string",
- "_effectiveDateTime": { },
- "effectivePeriod": { },
- "effectiveTiming": { },
- "effectiveInstant": "string",
- "_effectiveInstant": { },
- "issued": "string",
- "_issued": { },
- "performer": [
- null
], - "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "note": [
- { }
], - "bodySite": { },
- "method": { },
- "specimen": { },
- "device": { },
- "referenceRange": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "low": { },
- "high": { },
- "type": { },
- "appliesTo": [
- null
], - "age": { },
- "text": "string",
- "_text": { }
}
], - "hasMember": [
- null
], - "derivedFrom": [
- null
], - "component": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "code": { },
- "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "referenceRange": [
- null
]
}
]
}
Response samples
- 200
- 400
- 404
- 500
{- "resourceType": "Observation",
- "id": "string",
- "meta": {
- "id": "string",
- "extension": [
- {
- "id": "string",
- "extension": [
- null
], - "url": "string",
- "_url": {
- "id": "string",
- "extension": [
- null
]
}, - "valueBase64Binary": "string",
- "_valueBase64Binary": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueCanonical": "string",
- "_valueCanonical": { },
- "valueCode": "string",
- "_valueCode": { },
- "valueDate": "string",
- "_valueDate": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valueDecimal": 0,
- "_valueDecimal": { },
- "valueId": "string",
- "_valueId": { },
- "valueInstant": "string",
- "_valueInstant": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueMarkdown": "string",
- "_valueMarkdown": { },
- "valueOid": "string",
- "_valueOid": { },
- "valuePositiveInt": 0,
- "_valuePositiveInt": { },
- "valueString": "string",
- "_valueString": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueUnsignedInt": 0,
- "_valueUnsignedInt": { },
- "valueUri": "string",
- "_valueUri": { },
- "valueUrl": "string",
- "_valueUrl": { },
- "valueUuid": "string",
- "_valueUuid": { },
- "valueAddress": {
- "id": "string",
- "extension": [
- null
], - "use": "home",
- "_use": { },
- "type": "postal",
- "_type": { },
- "text": "string",
- "_text": { },
- "line": [
- "string"
], - "_line": [
- { }
], - "city": "string",
- "_city": { },
- "district": "string",
- "_district": { },
- "state": "string",
- "_state": { },
- "postalCode": "string",
- "_postalCode": { },
- "country": "string",
- "_country": { },
- "period": {
- "id": "string",
- "extension": [
- null
], - "start": "string",
- "_start": { },
- "end": "string",
- "_end": { }
}
}, - "valueAge": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueAnnotation": {
- "id": "string",
- "extension": [
- null
], - "authorReference": {
- "id": "string",
- "extension": [
- null
], - "reference": "string",
- "_reference": { },
- "type": "string",
- "_type": { },
- "identifier": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "type": {
- "id": "string",
- "extension": [
- null
], - "coding": [
- {
- "id": null,
- "extension": [ ],
- "system": null,
- "_system": { },
- "version": null,
- "_version": { },
- "code": null,
- "_code": { },
- "display": null,
- "_display": { },
- "userSelected": null,
- "_userSelected": { }
}
], - "text": "string",
- "_text": { }
}, - "system": "string",
- "_system": { },
- "value": "string",
- "_value": { },
- "period": { },
- "assigner": { }
}, - "display": "string",
- "_display": { }
}, - "authorString": "string",
- "_authorString": { },
- "time": "string",
- "_time": { },
- "text": "string",
- "_text": { }
}, - "valueAttachment": {
- "id": "string",
- "extension": [
- null
], - "contentType": "string",
- "_contentType": { },
- "language": "string",
- "_language": { },
- "data": "string",
- "_data": { },
- "url": "string",
- "_url": { },
- "size": 0,
- "_size": { },
- "hash": "string",
- "_hash": { },
- "title": "string",
- "_title": { },
- "creation": "string",
- "_creation": { }
}, - "valueCodeableConcept": { },
- "valueCoding": { },
- "valueContactPoint": {
- "id": "string",
- "extension": [
- null
], - "system": "phone",
- "_system": { },
- "value": "string",
- "_value": { },
- "use": "home",
- "_use": { },
- "rank": 0,
- "_rank": { },
- "period": { }
}, - "valueCount": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDistance": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDuration": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueHumanName": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "text": "string",
- "_text": { },
- "family": "string",
- "_family": { },
- "given": [
- null
], - "_given": [
- null
], - "prefix": [
- null
], - "_prefix": [
- null
], - "suffix": [
- null
], - "_suffix": [
- null
], - "period": { }
}, - "valueIdentifier": { },
- "valueMoney": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "currency": "string",
- "_currency": { }
}, - "valuePeriod": { },
- "valueQuantity": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueRange": {
- "id": "string",
- "extension": [
- null
], - "low": { },
- "high": { }
}, - "valueRatio": {
- "id": "string",
- "extension": [
- null
], - "numerator": { },
- "denominator": { }
}, - "valueReference": { },
- "valueSampledData": {
- "id": "string",
- "extension": [
- null
], - "origin": { },
- "period": 0,
- "_period": { },
- "factor": 0,
- "_factor": { },
- "lowerLimit": 0,
- "_lowerLimit": { },
- "upperLimit": 0,
- "_upperLimit": { },
- "dimensions": 0,
- "_dimensions": { },
- "data": "string",
- "_data": { }
}, - "valueSignature": {
- "id": "string",
- "extension": [
- null
], - "type": [
- null
], - "when": "string",
- "_when": { },
- "who": { },
- "onBehalfOf": { },
- "targetFormat": "string",
- "_targetFormat": { },
- "sigFormat": "string",
- "_sigFormat": { },
- "data": "string",
- "_data": { }
}, - "valueTiming": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "event": [
- "string"
], - "_event": [
- null
], - "repeat": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "boundsDuration": { },
- "boundsRange": { },
- "boundsPeriod": { },
- "count": 0,
- "_count": { },
- "countMax": 0,
- "_countMax": { },
- "duration": 0,
- "_duration": { },
- "durationMax": 0,
- "_durationMax": { },
- "durationUnit": "s",
- "_durationUnit": { },
- "frequency": 0,
- "_frequency": { },
- "frequencyMax": 0,
- "_frequencyMax": { },
- "period": 0,
- "_period": { },
- "periodMax": 0,
- "_periodMax": { },
- "periodUnit": "s",
- "_periodUnit": { },
- "dayOfWeek": [
- "string"
], - "_dayOfWeek": [
- null
], - "timeOfDay": [
- "string"
], - "_timeOfDay": [
- null
], - "when": [
- "MORN"
], - "_when": [
- null
], - "offset": 0,
- "_offset": { }
}, - "code": { }
}, - "valueContactDetail": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "telecom": [
- { }
]
}, - "valueContributor": {
- "id": "string",
- "extension": [
- null
], - "type": "author",
- "_type": { },
- "name": "string",
- "_name": { },
- "contact": [
- { }
]
}, - "valueDataRequirement": {
- "id": "string",
- "extension": [
- null
], - "type": "string",
- "_type": { },
- "profile": [
- "string"
], - "subjectCodeableConcept": { },
- "subjectReference": { },
- "mustSupport": [
- null
], - "_mustSupport": [
- null
], - "codeFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueSet": "string",
- "code": [
- null
]
}
], - "dateFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "valueDuration": { }
}
], - "limit": 0,
- "_limit": { },
- "sort": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "direction": "ascending",
- "_direction": { }
}
]
}, - "valueExpression": {
- "id": "string",
- "extension": [
- null
], - "description": "string",
- "_description": { },
- "name": "string",
- "_name": { },
- "language": "text/cql",
- "_language": { },
- "expression": "string",
- "_expression": { },
- "reference": "string",
- "_reference": { }
}, - "valueParameterDefinition": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "use": "string",
- "_use": { },
- "min": 0,
- "_min": { },
- "max": "string",
- "_max": { },
- "documentation": "string",
- "_documentation": { },
- "type": "string",
- "_type": { },
- "profile": "string"
}, - "valueRelatedArtifact": {
- "id": "string",
- "extension": [
- null
], - "type": "documentation",
- "_type": { },
- "label": "string",
- "_label": { },
- "display": "string",
- "_display": { },
- "citation": "string",
- "_citation": { },
- "url": "string",
- "_url": { },
- "document": { },
- "resource": "string"
}, - "valueTriggerDefinition": {
- "id": "string",
- "extension": [
- null
], - "type": "named-event",
- "_type": { },
- "name": "string",
- "_name": { },
- "timingTiming": { },
- "timingReference": { },
- "timingDate": "string",
- "_timingDate": { },
- "timingDateTime": "string",
- "_timingDateTime": { },
- "data": [
- { }
], - "condition": { }
}, - "valueUsageContext": {
- "id": "string",
- "extension": [
- null
], - "code": { },
- "valueCodeableConcept": { },
- "valueQuantity": { },
- "valueRange": { },
- "valueReference": { }
}, - "valueDosage": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "sequence": 0,
- "_sequence": { },
- "text": "string",
- "_text": { },
- "additionalInstruction": [
- { }
], - "patientInstruction": "string",
- "_patientInstruction": { },
- "timing": { },
- "asNeededBoolean": true,
- "_asNeededBoolean": { },
- "asNeededCodeableConcept": { },
- "site": { },
- "route": { },
- "method": { },
- "doseAndRate": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "type": { },
- "doseRange": { },
- "doseQuantity": { },
- "rateRatio": { },
- "rateRange": { },
- "rateQuantity": { }
}
], - "maxDosePerPeriod": { },
- "maxDosePerAdministration": { },
- "maxDosePerLifetime": { }
}, - "valueMeta": { }
}
], - "versionId": "string",
- "_versionId": { },
- "lastUpdated": "string",
- "_lastUpdated": { },
- "source": "string",
- "_source": { },
- "profile": [
- null
], - "security": [
- null
], - "tag": [
- null
]
}, - "implicitRules": "string",
- "_implicitRules": { },
- "language": "string",
- "_language": { },
- "text": {
- "id": "string",
- "extension": [
- null
], - "status": "generated",
- "_status": { },
- "div": null
}, - "extension": [
- null
], - "modifierExtension": [
- null
], - "identifier": [
- { }
], - "basedOn": [
- { }
], - "partOf": [
- null
], - "status": "registered",
- "_status": { },
- "category": [
- null
], - "code": { },
- "subject": { },
- "focus": [
- null
], - "encounter": { },
- "effectiveDateTime": "string",
- "_effectiveDateTime": { },
- "effectivePeriod": { },
- "effectiveTiming": { },
- "effectiveInstant": "string",
- "_effectiveInstant": { },
- "issued": "string",
- "_issued": { },
- "performer": [
- null
], - "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "note": [
- { }
], - "bodySite": { },
- "method": { },
- "specimen": { },
- "device": { },
- "referenceRange": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "low": { },
- "high": { },
- "type": { },
- "appliesTo": [
- null
], - "age": { },
- "text": "string",
- "_text": { }
}
], - "hasMember": [
- null
], - "derivedFrom": [
- null
], - "component": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "code": { },
- "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "referenceRange": [
- null
]
}
]
}
Update the current state of the resource
Update an instance of an observation resource using the resource's unique id. Note that this will result in a version of the resource being preserved on the server which can be retrieved using the vread
parameter See vreadObservation
Authorizations:
path Parameters
rid required | string Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0" id of the resource (=Resource.id) |
query Parameters
_summary | string Enum: "true" "text" "data" "count" "false" Requests the server to return a designated subset of the resource |
_elements | Array of any <string> [ items <string > ] Requests the server to return a collection of elements from the resource |
Request Body schema: application/fhir+jsonrequired
The new state of the resource
resourceType required | any Value: "Observation" This is a Observation resource |
id | string^[A-Za-z0-9\-\.]{1,64}$ The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
object The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | string^\S*$ String of characters used to identify a name or a resource |
object Base definition for all elements in a resource. | |
language | string^[^\s]+(\s[^\s]+)*$ A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents |
object Base definition for all elements in a resource. | |
object A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
extension | Array of any May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
modifierExtension | Array of any May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Array of objects A unique identifier assigned to this observation. | |
Array of objects A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. | |
partOf | Array of any A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
status | any Enum: "registered" "preliminary" "final" "amended" "corrected" "cancelled" "entered-in-error" "unknown" The status of the result value. |
object Base definition for all elements in a resource. | |
category | Array of any A code that classifies the general type of observation being made. |
required | object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
object A reference from one resource to another. | |
focus | Array of any The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
object A reference from one resource to another. | |
effectiveDateTime | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. |
object Base definition for all elements in a resource. | |
object A time period defined by a start and end date and optionally time. | |
object Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out. | |
effectiveInstant | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. |
object Base definition for all elements in a resource. | |
issued | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. |
object Base definition for all elements in a resource. | |
performer | Array of any Who was responsible for asserting the observed value as "true". |
object A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. | |
object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |
valueString | string^[ \r\n\t\S]+$ The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
valueBoolean | boolean^true|false$ The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
valueInteger | number^-?([0]|([1-9][0-9]*))$ The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
object The information determined as a result of making the observation, if the information has a simple value. | |
object The information determined as a result of making the observation, if the information has a simple value. | |
object The information determined as a result of making the observation, if the information has a simple value. | |
valueTime | string^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60... The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
valueDateTime | string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-... The information determined as a result of making the observation, if the information has a simple value. |
object Base definition for all elements in a resource. | |
object A time period defined by a start and end date and optionally time. | |
object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |
interpretation | Array of any A categorical assessment of an observation value. For example, high, low, normal. |
Array of objects Comments about the observation or the results. | |
object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |
object A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | |
object A reference from one resource to another. | |
object A reference from one resource to another. | |
Array of objects Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two | |
hasMember | Array of any This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
derivedFrom | Array of any The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
Array of objects Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Responses
Request samples
- Payload
{- "resourceType": "Observation",
- "id": "string",
- "meta": {
- "id": "string",
- "extension": [
- {
- "id": "string",
- "extension": [
- null
], - "url": "string",
- "_url": {
- "id": "string",
- "extension": [
- null
]
}, - "valueBase64Binary": "string",
- "_valueBase64Binary": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueCanonical": "string",
- "_valueCanonical": { },
- "valueCode": "string",
- "_valueCode": { },
- "valueDate": "string",
- "_valueDate": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valueDecimal": 0,
- "_valueDecimal": { },
- "valueId": "string",
- "_valueId": { },
- "valueInstant": "string",
- "_valueInstant": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueMarkdown": "string",
- "_valueMarkdown": { },
- "valueOid": "string",
- "_valueOid": { },
- "valuePositiveInt": 0,
- "_valuePositiveInt": { },
- "valueString": "string",
- "_valueString": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueUnsignedInt": 0,
- "_valueUnsignedInt": { },
- "valueUri": "string",
- "_valueUri": { },
- "valueUrl": "string",
- "_valueUrl": { },
- "valueUuid": "string",
- "_valueUuid": { },
- "valueAddress": {
- "id": "string",
- "extension": [
- null
], - "use": "home",
- "_use": { },
- "type": "postal",
- "_type": { },
- "text": "string",
- "_text": { },
- "line": [
- "string"
], - "_line": [
- { }
], - "city": "string",
- "_city": { },
- "district": "string",
- "_district": { },
- "state": "string",
- "_state": { },
- "postalCode": "string",
- "_postalCode": { },
- "country": "string",
- "_country": { },
- "period": {
- "id": "string",
- "extension": [
- null
], - "start": "string",
- "_start": { },
- "end": "string",
- "_end": { }
}
}, - "valueAge": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueAnnotation": {
- "id": "string",
- "extension": [
- null
], - "authorReference": {
- "id": "string",
- "extension": [
- null
], - "reference": "string",
- "_reference": { },
- "type": "string",
- "_type": { },
- "identifier": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "type": {
- "id": "string",
- "extension": [
- null
], - "coding": [
- {
- "id": null,
- "extension": [ ],
- "system": null,
- "_system": { },
- "version": null,
- "_version": { },
- "code": null,
- "_code": { },
- "display": null,
- "_display": { },
- "userSelected": null,
- "_userSelected": { }
}
], - "text": "string",
- "_text": { }
}, - "system": "string",
- "_system": { },
- "value": "string",
- "_value": { },
- "period": { },
- "assigner": { }
}, - "display": "string",
- "_display": { }
}, - "authorString": "string",
- "_authorString": { },
- "time": "string",
- "_time": { },
- "text": "string",
- "_text": { }
}, - "valueAttachment": {
- "id": "string",
- "extension": [
- null
], - "contentType": "string",
- "_contentType": { },
- "language": "string",
- "_language": { },
- "data": "string",
- "_data": { },
- "url": "string",
- "_url": { },
- "size": 0,
- "_size": { },
- "hash": "string",
- "_hash": { },
- "title": "string",
- "_title": { },
- "creation": "string",
- "_creation": { }
}, - "valueCodeableConcept": { },
- "valueCoding": { },
- "valueContactPoint": {
- "id": "string",
- "extension": [
- null
], - "system": "phone",
- "_system": { },
- "value": "string",
- "_value": { },
- "use": "home",
- "_use": { },
- "rank": 0,
- "_rank": { },
- "period": { }
}, - "valueCount": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDistance": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDuration": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueHumanName": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "text": "string",
- "_text": { },
- "family": "string",
- "_family": { },
- "given": [
- null
], - "_given": [
- null
], - "prefix": [
- null
], - "_prefix": [
- null
], - "suffix": [
- null
], - "_suffix": [
- null
], - "period": { }
}, - "valueIdentifier": { },
- "valueMoney": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "currency": "string",
- "_currency": { }
}, - "valuePeriod": { },
- "valueQuantity": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueRange": {
- "id": "string",
- "extension": [
- null
], - "low": { },
- "high": { }
}, - "valueRatio": {
- "id": "string",
- "extension": [
- null
], - "numerator": { },
- "denominator": { }
}, - "valueReference": { },
- "valueSampledData": {
- "id": "string",
- "extension": [
- null
], - "origin": { },
- "period": 0,
- "_period": { },
- "factor": 0,
- "_factor": { },
- "lowerLimit": 0,
- "_lowerLimit": { },
- "upperLimit": 0,
- "_upperLimit": { },
- "dimensions": 0,
- "_dimensions": { },
- "data": "string",
- "_data": { }
}, - "valueSignature": {
- "id": "string",
- "extension": [
- null
], - "type": [
- null
], - "when": "string",
- "_when": { },
- "who": { },
- "onBehalfOf": { },
- "targetFormat": "string",
- "_targetFormat": { },
- "sigFormat": "string",
- "_sigFormat": { },
- "data": "string",
- "_data": { }
}, - "valueTiming": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "event": [
- "string"
], - "_event": [
- null
], - "repeat": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "boundsDuration": { },
- "boundsRange": { },
- "boundsPeriod": { },
- "count": 0,
- "_count": { },
- "countMax": 0,
- "_countMax": { },
- "duration": 0,
- "_duration": { },
- "durationMax": 0,
- "_durationMax": { },
- "durationUnit": "s",
- "_durationUnit": { },
- "frequency": 0,
- "_frequency": { },
- "frequencyMax": 0,
- "_frequencyMax": { },
- "period": 0,
- "_period": { },
- "periodMax": 0,
- "_periodMax": { },
- "periodUnit": "s",
- "_periodUnit": { },
- "dayOfWeek": [
- "string"
], - "_dayOfWeek": [
- null
], - "timeOfDay": [
- "string"
], - "_timeOfDay": [
- null
], - "when": [
- "MORN"
], - "_when": [
- null
], - "offset": 0,
- "_offset": { }
}, - "code": { }
}, - "valueContactDetail": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "telecom": [
- { }
]
}, - "valueContributor": {
- "id": "string",
- "extension": [
- null
], - "type": "author",
- "_type": { },
- "name": "string",
- "_name": { },
- "contact": [
- { }
]
}, - "valueDataRequirement": {
- "id": "string",
- "extension": [
- null
], - "type": "string",
- "_type": { },
- "profile": [
- "string"
], - "subjectCodeableConcept": { },
- "subjectReference": { },
- "mustSupport": [
- null
], - "_mustSupport": [
- null
], - "codeFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueSet": "string",
- "code": [
- null
]
}
], - "dateFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "valueDuration": { }
}
], - "limit": 0,
- "_limit": { },
- "sort": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "direction": "ascending",
- "_direction": { }
}
]
}, - "valueExpression": {
- "id": "string",
- "extension": [
- null
], - "description": "string",
- "_description": { },
- "name": "string",
- "_name": { },
- "language": "text/cql",
- "_language": { },
- "expression": "string",
- "_expression": { },
- "reference": "string",
- "_reference": { }
}, - "valueParameterDefinition": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "use": "string",
- "_use": { },
- "min": 0,
- "_min": { },
- "max": "string",
- "_max": { },
- "documentation": "string",
- "_documentation": { },
- "type": "string",
- "_type": { },
- "profile": "string"
}, - "valueRelatedArtifact": {
- "id": "string",
- "extension": [
- null
], - "type": "documentation",
- "_type": { },
- "label": "string",
- "_label": { },
- "display": "string",
- "_display": { },
- "citation": "string",
- "_citation": { },
- "url": "string",
- "_url": { },
- "document": { },
- "resource": "string"
}, - "valueTriggerDefinition": {
- "id": "string",
- "extension": [
- null
], - "type": "named-event",
- "_type": { },
- "name": "string",
- "_name": { },
- "timingTiming": { },
- "timingReference": { },
- "timingDate": "string",
- "_timingDate": { },
- "timingDateTime": "string",
- "_timingDateTime": { },
- "data": [
- { }
], - "condition": { }
}, - "valueUsageContext": {
- "id": "string",
- "extension": [
- null
], - "code": { },
- "valueCodeableConcept": { },
- "valueQuantity": { },
- "valueRange": { },
- "valueReference": { }
}, - "valueDosage": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "sequence": 0,
- "_sequence": { },
- "text": "string",
- "_text": { },
- "additionalInstruction": [
- { }
], - "patientInstruction": "string",
- "_patientInstruction": { },
- "timing": { },
- "asNeededBoolean": true,
- "_asNeededBoolean": { },
- "asNeededCodeableConcept": { },
- "site": { },
- "route": { },
- "method": { },
- "doseAndRate": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "type": { },
- "doseRange": { },
- "doseQuantity": { },
- "rateRatio": { },
- "rateRange": { },
- "rateQuantity": { }
}
], - "maxDosePerPeriod": { },
- "maxDosePerAdministration": { },
- "maxDosePerLifetime": { }
}, - "valueMeta": { }
}
], - "versionId": "string",
- "_versionId": { },
- "lastUpdated": "string",
- "_lastUpdated": { },
- "source": "string",
- "_source": { },
- "profile": [
- null
], - "security": [
- null
], - "tag": [
- null
]
}, - "implicitRules": "string",
- "_implicitRules": { },
- "language": "string",
- "_language": { },
- "text": {
- "id": "string",
- "extension": [
- null
], - "status": "generated",
- "_status": { },
- "div": null
}, - "extension": [
- null
], - "modifierExtension": [
- null
], - "identifier": [
- { }
], - "basedOn": [
- { }
], - "partOf": [
- null
], - "status": "registered",
- "_status": { },
- "category": [
- null
], - "code": { },
- "subject": { },
- "focus": [
- null
], - "encounter": { },
- "effectiveDateTime": "string",
- "_effectiveDateTime": { },
- "effectivePeriod": { },
- "effectiveTiming": { },
- "effectiveInstant": "string",
- "_effectiveInstant": { },
- "issued": "string",
- "_issued": { },
- "performer": [
- null
], - "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "note": [
- { }
], - "bodySite": { },
- "method": { },
- "specimen": { },
- "device": { },
- "referenceRange": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "low": { },
- "high": { },
- "type": { },
- "appliesTo": [
- null
], - "age": { },
- "text": "string",
- "_text": { }
}
], - "hasMember": [
- null
], - "derivedFrom": [
- null
], - "component": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "code": { },
- "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "referenceRange": [
- null
]
}
]
}
Response samples
- 200
- 400
- 404
- 500
{- "resourceType": "Observation",
- "id": "string",
- "meta": {
- "id": "string",
- "extension": [
- {
- "id": "string",
- "extension": [
- null
], - "url": "string",
- "_url": {
- "id": "string",
- "extension": [
- null
]
}, - "valueBase64Binary": "string",
- "_valueBase64Binary": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueCanonical": "string",
- "_valueCanonical": { },
- "valueCode": "string",
- "_valueCode": { },
- "valueDate": "string",
- "_valueDate": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valueDecimal": 0,
- "_valueDecimal": { },
- "valueId": "string",
- "_valueId": { },
- "valueInstant": "string",
- "_valueInstant": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueMarkdown": "string",
- "_valueMarkdown": { },
- "valueOid": "string",
- "_valueOid": { },
- "valuePositiveInt": 0,
- "_valuePositiveInt": { },
- "valueString": "string",
- "_valueString": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueUnsignedInt": 0,
- "_valueUnsignedInt": { },
- "valueUri": "string",
- "_valueUri": { },
- "valueUrl": "string",
- "_valueUrl": { },
- "valueUuid": "string",
- "_valueUuid": { },
- "valueAddress": {
- "id": "string",
- "extension": [
- null
], - "use": "home",
- "_use": { },
- "type": "postal",
- "_type": { },
- "text": "string",
- "_text": { },
- "line": [
- "string"
], - "_line": [
- { }
], - "city": "string",
- "_city": { },
- "district": "string",
- "_district": { },
- "state": "string",
- "_state": { },
- "postalCode": "string",
- "_postalCode": { },
- "country": "string",
- "_country": { },
- "period": {
- "id": "string",
- "extension": [
- null
], - "start": "string",
- "_start": { },
- "end": "string",
- "_end": { }
}
}, - "valueAge": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueAnnotation": {
- "id": "string",
- "extension": [
- null
], - "authorReference": {
- "id": "string",
- "extension": [
- null
], - "reference": "string",
- "_reference": { },
- "type": "string",
- "_type": { },
- "identifier": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "type": {
- "id": "string",
- "extension": [
- null
], - "coding": [
- {
- "id": null,
- "extension": [ ],
- "system": null,
- "_system": { },
- "version": null,
- "_version": { },
- "code": null,
- "_code": { },
- "display": null,
- "_display": { },
- "userSelected": null,
- "_userSelected": { }
}
], - "text": "string",
- "_text": { }
}, - "system": "string",
- "_system": { },
- "value": "string",
- "_value": { },
- "period": { },
- "assigner": { }
}, - "display": "string",
- "_display": { }
}, - "authorString": "string",
- "_authorString": { },
- "time": "string",
- "_time": { },
- "text": "string",
- "_text": { }
}, - "valueAttachment": {
- "id": "string",
- "extension": [
- null
], - "contentType": "string",
- "_contentType": { },
- "language": "string",
- "_language": { },
- "data": "string",
- "_data": { },
- "url": "string",
- "_url": { },
- "size": 0,
- "_size": { },
- "hash": "string",
- "_hash": { },
- "title": "string",
- "_title": { },
- "creation": "string",
- "_creation": { }
}, - "valueCodeableConcept": { },
- "valueCoding": { },
- "valueContactPoint": {
- "id": "string",
- "extension": [
- null
], - "system": "phone",
- "_system": { },
- "value": "string",
- "_value": { },
- "use": "home",
- "_use": { },
- "rank": 0,
- "_rank": { },
- "period": { }
}, - "valueCount": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDistance": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueDuration": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueHumanName": {
- "id": "string",
- "extension": [
- null
], - "use": "usual",
- "_use": { },
- "text": "string",
- "_text": { },
- "family": "string",
- "_family": { },
- "given": [
- null
], - "_given": [
- null
], - "prefix": [
- null
], - "_prefix": [
- null
], - "suffix": [
- null
], - "_suffix": [
- null
], - "period": { }
}, - "valueIdentifier": { },
- "valueMoney": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "currency": "string",
- "_currency": { }
}, - "valuePeriod": { },
- "valueQuantity": {
- "id": "string",
- "extension": [
- null
], - "value": 0,
- "_value": { },
- "comparator": "<",
- "_comparator": { },
- "unit": "string",
- "_unit": { },
- "system": "string",
- "_system": { },
- "code": "string",
- "_code": { }
}, - "valueRange": {
- "id": "string",
- "extension": [
- null
], - "low": { },
- "high": { }
}, - "valueRatio": {
- "id": "string",
- "extension": [
- null
], - "numerator": { },
- "denominator": { }
}, - "valueReference": { },
- "valueSampledData": {
- "id": "string",
- "extension": [
- null
], - "origin": { },
- "period": 0,
- "_period": { },
- "factor": 0,
- "_factor": { },
- "lowerLimit": 0,
- "_lowerLimit": { },
- "upperLimit": 0,
- "_upperLimit": { },
- "dimensions": 0,
- "_dimensions": { },
- "data": "string",
- "_data": { }
}, - "valueSignature": {
- "id": "string",
- "extension": [
- null
], - "type": [
- null
], - "when": "string",
- "_when": { },
- "who": { },
- "onBehalfOf": { },
- "targetFormat": "string",
- "_targetFormat": { },
- "sigFormat": "string",
- "_sigFormat": { },
- "data": "string",
- "_data": { }
}, - "valueTiming": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "event": [
- "string"
], - "_event": [
- null
], - "repeat": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "boundsDuration": { },
- "boundsRange": { },
- "boundsPeriod": { },
- "count": 0,
- "_count": { },
- "countMax": 0,
- "_countMax": { },
- "duration": 0,
- "_duration": { },
- "durationMax": 0,
- "_durationMax": { },
- "durationUnit": "s",
- "_durationUnit": { },
- "frequency": 0,
- "_frequency": { },
- "frequencyMax": 0,
- "_frequencyMax": { },
- "period": 0,
- "_period": { },
- "periodMax": 0,
- "_periodMax": { },
- "periodUnit": "s",
- "_periodUnit": { },
- "dayOfWeek": [
- "string"
], - "_dayOfWeek": [
- null
], - "timeOfDay": [
- "string"
], - "_timeOfDay": [
- null
], - "when": [
- "MORN"
], - "_when": [
- null
], - "offset": 0,
- "_offset": { }
}, - "code": { }
}, - "valueContactDetail": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "telecom": [
- { }
]
}, - "valueContributor": {
- "id": "string",
- "extension": [
- null
], - "type": "author",
- "_type": { },
- "name": "string",
- "_name": { },
- "contact": [
- { }
]
}, - "valueDataRequirement": {
- "id": "string",
- "extension": [
- null
], - "type": "string",
- "_type": { },
- "profile": [
- "string"
], - "subjectCodeableConcept": { },
- "subjectReference": { },
- "mustSupport": [
- null
], - "_mustSupport": [
- null
], - "codeFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueSet": "string",
- "code": [
- null
]
}
], - "dateFilter": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "searchParam": "string",
- "_searchParam": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "valueDuration": { }
}
], - "limit": 0,
- "_limit": { },
- "sort": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "path": "string",
- "_path": { },
- "direction": "ascending",
- "_direction": { }
}
]
}, - "valueExpression": {
- "id": "string",
- "extension": [
- null
], - "description": "string",
- "_description": { },
- "name": "string",
- "_name": { },
- "language": "text/cql",
- "_language": { },
- "expression": "string",
- "_expression": { },
- "reference": "string",
- "_reference": { }
}, - "valueParameterDefinition": {
- "id": "string",
- "extension": [
- null
], - "name": "string",
- "_name": { },
- "use": "string",
- "_use": { },
- "min": 0,
- "_min": { },
- "max": "string",
- "_max": { },
- "documentation": "string",
- "_documentation": { },
- "type": "string",
- "_type": { },
- "profile": "string"
}, - "valueRelatedArtifact": {
- "id": "string",
- "extension": [
- null
], - "type": "documentation",
- "_type": { },
- "label": "string",
- "_label": { },
- "display": "string",
- "_display": { },
- "citation": "string",
- "_citation": { },
- "url": "string",
- "_url": { },
- "document": { },
- "resource": "string"
}, - "valueTriggerDefinition": {
- "id": "string",
- "extension": [
- null
], - "type": "named-event",
- "_type": { },
- "name": "string",
- "_name": { },
- "timingTiming": { },
- "timingReference": { },
- "timingDate": "string",
- "_timingDate": { },
- "timingDateTime": "string",
- "_timingDateTime": { },
- "data": [
- { }
], - "condition": { }
}, - "valueUsageContext": {
- "id": "string",
- "extension": [
- null
], - "code": { },
- "valueCodeableConcept": { },
- "valueQuantity": { },
- "valueRange": { },
- "valueReference": { }
}, - "valueDosage": {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "sequence": 0,
- "_sequence": { },
- "text": "string",
- "_text": { },
- "additionalInstruction": [
- { }
], - "patientInstruction": "string",
- "_patientInstruction": { },
- "timing": { },
- "asNeededBoolean": true,
- "_asNeededBoolean": { },
- "asNeededCodeableConcept": { },
- "site": { },
- "route": { },
- "method": { },
- "doseAndRate": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "type": { },
- "doseRange": { },
- "doseQuantity": { },
- "rateRatio": { },
- "rateRange": { },
- "rateQuantity": { }
}
], - "maxDosePerPeriod": { },
- "maxDosePerAdministration": { },
- "maxDosePerLifetime": { }
}, - "valueMeta": { }
}
], - "versionId": "string",
- "_versionId": { },
- "lastUpdated": "string",
- "_lastUpdated": { },
- "source": "string",
- "_source": { },
- "profile": [
- null
], - "security": [
- null
], - "tag": [
- null
]
}, - "implicitRules": "string",
- "_implicitRules": { },
- "language": "string",
- "_language": { },
- "text": {
- "id": "string",
- "extension": [
- null
], - "status": "generated",
- "_status": { },
- "div": null
}, - "extension": [
- null
], - "modifierExtension": [
- null
], - "identifier": [
- { }
], - "basedOn": [
- { }
], - "partOf": [
- null
], - "status": "registered",
- "_status": { },
- "category": [
- null
], - "code": { },
- "subject": { },
- "focus": [
- null
], - "encounter": { },
- "effectiveDateTime": "string",
- "_effectiveDateTime": { },
- "effectivePeriod": { },
- "effectiveTiming": { },
- "effectiveInstant": "string",
- "_effectiveInstant": { },
- "issued": "string",
- "_issued": { },
- "performer": [
- null
], - "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "note": [
- { }
], - "bodySite": { },
- "method": { },
- "specimen": { },
- "device": { },
- "referenceRange": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "low": { },
- "high": { },
- "type": { },
- "appliesTo": [
- null
], - "age": { },
- "text": "string",
- "_text": { }
}
], - "hasMember": [
- null
], - "derivedFrom": [
- null
], - "component": [
- {
- "id": "string",
- "extension": [
- null
], - "modifierExtension": [
- null
], - "code": { },
- "valueQuantity": { },
- "valueCodeableConcept": { },
- "valueString": "string",
- "_valueString": { },
- "valueBoolean": true,
- "_valueBoolean": { },
- "valueInteger": 0,
- "_valueInteger": { },
- "valueRange": { },
- "valueRatio": { },
- "valueSampledData": { },
- "valueTime": "string",
- "_valueTime": { },
- "valueDateTime": "string",
- "_valueDateTime": { },
- "valuePeriod": { },
- "dataAbsentReason": { },
- "interpretation": [
- null
], - "referenceRange": [
- null
]
}
]
}
Delete the resource so that it no exists (no read, search etc)
Permanently delete an instance of an observation resource from the server
Authorizations:
path Parameters
rid required | string Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0" id of the resource (=Resource.id) |
Responses
Response samples
- 400
- 404
- 500
{- "resourceType": "OperationOutcome",
- "text": {
- "status": "generated",
- "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h1>Operation Outcome</h1><table border=\"0\"><tr><td style=\"font-weight: bold;\">error</td><td>[]</td><td><pre>Condition - Unrecognised property '@someNonsenseProperty'</pre></td></tr></table></div>"
}, - "issue": [
- {
- "severity": "error",
- "code": "invalid",
- "diagnostics": "Condition - Unrecognised property '@someNonsenseProperty'"
}
]
}