Practice Fusion FHIR® API Specifications
Contents
Authentication and Authorization
Confidential Clients
Practice Fusion supports the following authentication and authorization methods for Confidential Clients:
| App Type | Authentication | Grant-Type | O-Auth Flow |
|---|---|---|---|
| Standalone Launch | Symmetric (Shared Secret) | Authorization Code | 3-legged |
| EHR Launch | Symmetric (Shared Secret) | Authorization Code | 3-legged |
| Bulk-Data | Asymmetric (Public Key) | Client Credentials | 2-legged |
Non-Confidential Clients
For native/public applications that cannot store a secret, PKCE is not required. The application can register as a public stand-alone launch app. The application can authorize using the “authorization code” grant type.
Capability Statement and Well-known Smart Configuration
Endpoints
Authorize, Introspection, and Token Endpoints
These can be found by requesting the well-known configuration or the capability statement from the Practice Fusion FHIR server.
Well-Known Smart Configuration
Method: GET
{{BaseURL}}/.well-known/smart-configuration
Examples
Well-Known Smart Configuration PHR
Request
GET {{BaseURL}}/.well-known/smart-configuration
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json |
Body
{
"authorization_endpoint": "{{BaseURL}}/authorize",
"token_endpoint": "{{BaseURL}}/token",
"introspection_endpoint": "{{BaseURL}}/introspect",
"capabilities": [
"launch-ehr",
"launch-standalone",
"client-public",
"client-confidential-symmetric",
"sso-openid-connect",
"context-banner",
"context-style",
"context-ehr-patient",
"context-ehr-encounter",
"context-standalone-patient",
"context-standalone-encounter",
"permission-offline",
"permission-patient",
"permission-user"
]
}Well-Known Smart Configuration EHR
Request
GET {{BaseURL}}/.well-known/smart-configuration
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"authorization_endpoint": "{{BaseURL}}/authorize",
"token_endpoint": "{{BaseURL}}/token",
"introspection_endpoint": "{{BaseURL}}/introspect",
"capabilities": [
"launch-ehr",
"launch-standalone",
"client-public",
"client-confidential-symmetric",
"sso-openid-connect",
"context-banner",
"context-style",
"context-ehr-patient",
"context-ehr-encounter",
"context-standalone-patient",
"context-standalone-encounter",
"permission-offline",
"permission-patient",
"permission-user"
],
"grant_types_supported": [
"authorization_code",
"refresh_token",
"client_credentials"
],
"code_challenge_methods_supported": [
"S256"
]
}Metadata
Method: GET
{{BaseURL}}/metadata
Examples
Metadata PHR
Request
GET {{BaseURL}}/metadata
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"date": "2022-03-01",
"description": "NXT API conformance statement",
"fhirVersion": "4.0.1",
"format": [
"json"
],
"id": "2eec11d3-106f-4fac-8430-ae83a8b3ca7b",
"kind": "capability",
"name": "NXT API FHIR Capability Statement",
"publisher": "MedicaSoft, LLC",
"resourceType": "CapabilityStatement",
"instantiates": [
"http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data"
],
"rest": [
{
"documentation": "NXT API functionality",
"mode": "server",
"resource": [
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
],
"searchInclude": [
"AllergyIntolerance.asserter",
"AllergyIntolerance.patient",
"AllergyIntolerance.recorder"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Date record was believed accurate",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-manifestation",
"documentation": "Clinical symptoms/signs associated with the Event",
"name": "manifestation",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder",
"documentation": "Who recorded the sensitivity",
"name": "recorder",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Code that identifies the allergy or intolerance",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-criticality",
"documentation": "low | high | unable-to-assess",
"name": "criticality",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
"documentation": "active | inactive | resolved",
"name": "clinical-status",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"documentation": "allergy | intolerance - Underlying mechanism (if known)",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-onset",
"documentation": "Date(/time) when manifestations showed",
"name": "onset",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who the sensitivity is for",
"name": "patient",
"type": "reference"
}
],
"type": "AllergyIntolerance"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-date",
"documentation": "Time when the event occurred on source",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-type",
"documentation": "Type of entity involved",
"name": "entity-type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent",
"documentation": "Direct reference to resource",
"name": "agent",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-address",
"documentation": "Identifier for the network access point of the user device",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-source",
"documentation": "The identity of source detecting the event",
"name": "source",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-type",
"documentation": "Type/identifier of event",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-altid",
"documentation": "Alternative User id e.g. authentication",
"name": "altid",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-site",
"documentation": "Logical source location within the enterprise",
"name": "site",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-name",
"documentation": "Human-meaningful name for the agent",
"name": "agent-name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-subtype",
"documentation": "More specific type/id for the event",
"name": "subtype",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-patient",
"documentation": "Direct reference to resource",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-action",
"documentation": "Type of action performed during the event",
"name": "action",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-user",
"documentation": "Unique identifier for the user",
"name": "user",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity",
"documentation": "Specific instance of resource",
"name": "entity",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-id",
"documentation": "Specific instance of object",
"name": "entity-id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-outcome",
"documentation": "Whether the event succeeded or failed",
"name": "outcome",
"type": "token"
}
],
"type": "AuditEvent"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Binary",
"type": "Binary"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/CapabilityStatement",
"type": "CapabilityStatement"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Composition",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Composition editing time",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "Logical identifier of composition (version-independent)",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-subject",
"documentation": "Who and/or what the composition is about",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-author",
"documentation": "Who and/or what authored the composition",
"name": "author",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-confidentiality",
"documentation": "As defined by affinity domain",
"name": "confidentiality",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-section",
"documentation": "Classification of section (recommended)",
"name": "section",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Context of the Composition",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"documentation": "Kind of composition (LOINC if possible)",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-title",
"documentation": "Human Readable name/title",
"name": "title",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-attester",
"documentation": "Who attested the composition",
"name": "attester",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-entry",
"documentation": "A reference to data that supports this section",
"name": "entry",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who and/or what the composition is about",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-context",
"documentation": "Code(s) that apply to the event being documented",
"name": "context",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-class",
"documentation": "Categorization of Composition",
"name": "class",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-status",
"documentation": "preliminary | final | amended | entered-in-error",
"name": "status",
"type": "token"
}
],
"type": "Composition"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Condition",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
],
"searchInclude": [
"Condition.asserter",
"Condition.context",
"Condition.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-severity",
"documentation": "The severity of the condition",
"name": "severity",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Code for the condition",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-evidence",
"documentation": "Manifestation/symptom",
"name": "evidence",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-subject",
"documentation": "Who has the condition?",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"documentation": "The clinical status of the condition",
"name": "clinical-status",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-encounter",
"documentation": "Encounter when condition first asserted",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-boolean",
"documentation": "Abatement boolean (boolean is true or non-boolean values are present)",
"name": "abatement-boolean",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-date",
"documentation": "Date related onsets (dateTime and Period)",
"name": "onset-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-date",
"documentation": "Date-related abatements (dateTime and period)",
"name": "abatement-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-asserter",
"documentation": "Person who asserts this condition",
"name": "asserter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-stage",
"documentation": "Simple summary (disease specific)",
"name": "stage",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who has the condition?",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-asserted-date",
"documentation": "Date record was believed accurate",
"name": "asserted-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-category",
"documentation": "The category of the condition",
"name": "category",
"type": "token"
}
],
"type": "Condition"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Contract",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Contract-identifier",
"documentation": "The identity of the contract",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Contract-patient",
"documentation": "The identity of the subject of the contract (if a patient)",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Contract-subject",
"documentation": "The identity of the subject of the contract",
"name": "subject",
"type": "reference"
}
],
"type": "Contract"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage",
"searchInclude": [
"Coverage.contract"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-identifier",
"documentation": "The primary identifier of the insured and the coverage",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-subscriber",
"documentation": "Reference to the subscriber",
"name": "subscriber",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-subplan",
"documentation": "Sub-plan identifier",
"name": "subplan",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-type",
"documentation": "The kind of coverage (health plan, auto, Workers Compensation)",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-sequence",
"documentation": "Sequence number",
"name": "sequence",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-plan",
"documentation": "A plan or policy identifier",
"name": "plan",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-dependent",
"documentation": "Dependent number",
"name": "dependent",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-group",
"documentation": "Group identifier",
"name": "group",
"type": "string"
}
],
"type": "Coverage"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Device",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-udi-di",
"documentation": "The udi Device Identifier (DI)",
"name": "udi-di",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-identifier",
"documentation": "Instance id from manufacturer, owner, and others",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-device-name",
"documentation": "A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text",
"name": "device-name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-patient",
"documentation": "Patient information, if the resource is affixed to a person",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-organization",
"documentation": "The organization responsible for the device",
"name": "organization",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-model",
"documentation": "The model of the device",
"name": "model",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-location",
"documentation": "A location, where the resource is found",
"name": "location",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-type",
"documentation": "The type of the device",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-url",
"documentation": "Network address to contact device",
"name": "url",
"type": "uri"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-manufacturer",
"documentation": "The manufacturer of the device",
"name": "manufacturer",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-status",
"documentation": "active | inactive | entered-in-error | unknown",
"name": "status",
"type": "token"
}
],
"type": "Device"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
],
"searchInclude": [
"DiagnosticReport.context",
"DiagnosticReport.imagingstudy",
"DiagnosticReport.performer",
"DiagnosticReport.result",
"DiagnosticReport.specimen",
"DiagnosticReport.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "The clinically relevant time of the report",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "An identifier for the report",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-image",
"documentation": "A reference to the image source.",
"name": "image",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-performer",
"documentation": "Who was the source of the report (organization)",
"name": "performer",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-subject",
"documentation": "The subject of the report",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-diagnosis",
"documentation": "A coded diagnosis on the report",
"name": "diagnosis",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "The Encounter when the order was made",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-result",
"documentation": "Link to an atomic result (observation resource)",
"name": "result",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The subject of the report if a patient",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-specimen",
"documentation": "The specimen details",
"name": "specimen",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-issued",
"documentation": "When the report was issued",
"name": "issued",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
"documentation": "Which diagnostic discipline/department created the report",
"name": "category",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-status",
"documentation": "The status of the report",
"name": "status",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-interpretation",
"documentation": "The aggregated interpretation of the observation results: normal, abnormal, critical",
"name": "interpretation",
"type": "token"
}
],
"type": "DiagnosticReport"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-securitylabel",
"documentation": "Document security-tags",
"name": "securitylabel",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject",
"documentation": "Who/what is the subject of the document",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-description",
"documentation": "Human-readable description (title)",
"name": "description",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-language",
"documentation": "Human language of the content (BCP-47)",
"name": "language",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"documentation": "Kind of document (LOINC if possible)",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relation",
"documentation": "replaces | transforms | signs | appends",
"name": "relation",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who/what is the subject of the document",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"documentation": "Main clinical acts documented",
"name": "event",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-class",
"documentation": "Categorization of document",
"name": "class",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-authenticator",
"documentation": "Who/what authenticated the document",
"name": "authenticator",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "Master Version Specific Identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"documentation": "Time of service that is being documented",
"name": "period",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-custodian",
"documentation": "Organization which maintains the document",
"name": "custodian",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-indexed",
"documentation": "When this document reference was created",
"name": "indexed",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
"documentation": "Who and/or what authored the document",
"name": "author",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-created",
"documentation": "Document creation time",
"name": "created",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"documentation": "Format/content rules for the document",
"name": "format",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Context of the document content",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-location",
"documentation": "Uri where the data can be found",
"name": "location",
"type": "uri"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto",
"documentation": "Target of the relationship",
"name": "relatesto",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"documentation": "Kind of facility where patient was seen",
"name": "facility",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"documentation": "current | superseded | entered-in-error",
"name": "status",
"type": "token"
}
],
"type": "DocumentReference"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
],
"searchInclude": [
"Encounter.appointment",
"Encounter.diagnosis",
"Encounter.episodeofcare",
"Encounter.location",
"Encounter.participant",
"Encounter.service-provider",
"Encounter.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "A date within the period the Encounter lasted",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "Identifier(s) by which this encounter is known",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-episodeofcare",
"documentation": "Episode(s) of care that this encounter should be recorded against",
"name": "episodeofcare",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant-type",
"documentation": "Role of participant in encounter",
"name": "participant-type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-practitioner",
"documentation": "Persons involved in the encounter other than the patient",
"name": "practitioner",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-subject",
"documentation": "The patient ro group present at the encounter",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-length",
"documentation": "Length of encounter in days",
"name": "length",
"type": "quantity"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-diagnosis",
"documentation": "Reason the encounter takes place (resource)",
"name": "diagnosis",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-appointment",
"documentation": "The appointment that scheduled this encounter",
"name": "appointment",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant",
"documentation": "Persons involved in the encounter other than the patient",
"name": "participant",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient ro group present at the encounter",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-location-period",
"documentation": "Time period during which the patient was present at the location",
"name": "location-period",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-location",
"documentation": "Location the encounter takes place",
"name": "location",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-service-provider",
"documentation": "The custodian organization of this Encounter record",
"name": "service-provider",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement",
"documentation": "Wheelchair, translator, stretcher, etc.",
"name": "special-arrangement",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-class",
"documentation": "inpatient | outpatient | ambulatory | emergency +",
"name": "class",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-status",
"documentation": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"name": "status",
"type": "token"
}
],
"type": "Encounter"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-condition",
"documentation": "Conditions/problems/diagnoses this episode of care is for",
"name": "condition",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient who is the focus of this episode of care",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-organization",
"documentation": "The organization that has assumed the specific responsibilities of this EpisodeOfCare",
"name": "organization",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"documentation": "Type/class - e.g. specialist referral, disease management",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-care-manager",
"documentation": "Care manager/care co-ordinator for the patient",
"name": "care-manager",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-status",
"documentation": "The current status of the Episode of Care as provided (does not check the status history collection)",
"name": "status",
"type": "token"
}
],
"type": "EpisodeOfCare"
},
{
"conditionalCreate": true,
"conditionalDelete": "multiple",
"conditionalUpdate": true,
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The identity of a subject to list family member history items for",
"name": "patient",
"type": "reference"
}
],
"type": "FamilyMemberHistory"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Flag",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Flag-subject",
"documentation": "The identity of a subject to list flags for",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The identity of a subject to list flags for",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Alert relevant during encounter",
"name": "encounter",
"type": "reference"
}
],
"type": "Flag"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Goal",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who this goal is intended for",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-subject",
"documentation": "Who this goal is intended for",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-start-date",
"documentation": "When goal pursuit begins",
"name": "start-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-category",
"documentation": "E.g. Treatment, dietary, behavioral, etc.",
"name": "category",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"documentation": "Reach goal on or before",
"name": "target-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-status",
"documentation": "proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected",
"name": "status",
"type": "token"
}
],
"type": "Goal"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Group",
"operation": [
{
"name": "export",
"definition": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export"
}
],
"type": "Group"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"searchInclude": [
"ImagingStudy.patient",
"ImagingStudy.performer"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-study",
"documentation": "The study identifier for the image",
"name": "study",
"type": "uri"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-dicom-class",
"documentation": "The type of the instance",
"name": "dicom-class",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-modality",
"documentation": "The modality of the series",
"name": "modality",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-bodysite",
"documentation": "The body site studied",
"name": "bodysite",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-started",
"documentation": "When the study was started",
"name": "started",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-accession",
"documentation": "The accession identifier for the study",
"name": "accession",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-uid",
"documentation": "The instance unique identifier",
"name": "uid",
"type": "uri"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who the study is about",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-series",
"documentation": "The identifier of the series of images",
"name": "series",
"type": "token"
}
],
"type": "ImagingStudy"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
],
"searchInclude": [
"Immunization.encounter",
"Immunization.location",
"Immunization.manufacturer",
"Immunization.patient",
"Immunization.reaction"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Vaccination (non)-Administration Date",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "Business identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason",
"documentation": "Why immunization occurred",
"name": "reason",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction",
"documentation": "Additional information on reaction",
"name": "reaction",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-lot-number",
"documentation": "Vaccine Lot Number",
"name": "lot-number",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-practitioner",
"documentation": "The practitioner who played a role in the vaccination",
"name": "practitioner",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-notgiven",
"documentation": "Administrations which were not given",
"name": "notgiven",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-manufacturer",
"documentation": "Vaccine Manufacturer",
"name": "manufacturer",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-dose-sequence",
"documentation": "Dose number within series",
"name": "dose-sequence",
"type": "number"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient for the vaccination record",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code",
"documentation": "Vaccine Product Administered",
"name": "vaccine-code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason-not-given",
"documentation": "Explanation of reason vaccination was not administered",
"name": "reason-not-given",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-location",
"documentation": "The service delivery location or facility in which the vaccine was / was to be administered",
"name": "location",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction-date",
"documentation": "When reaction started",
"name": "reaction-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-status",
"documentation": "Immunization event status",
"name": "status",
"type": "token"
}
],
"type": "Immunization"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/List",
"searchInclude": [
"List.item"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "When the list was prepared",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-item",
"documentation": "Actual entry",
"name": "item",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-empty-reason",
"documentation": "Why list is empty",
"name": "empty-reason",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "What the purpose of this list is",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-subject",
"documentation": "If all resources have the same subject",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "If all resources have the same subject",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-source",
"documentation": "Who and/or what defined the list contents (aka Author)",
"name": "source",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Context in which list created",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-status",
"documentation": "current | retired | entered-in-error",
"name": "status",
"type": "token"
}
],
"type": "List"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Location",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-identifier",
"documentation": "An identifier for the location",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-partof",
"documentation": "A location of which this location is a part",
"name": "partof",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-address",
"documentation": "A (part of the) address of the location",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-type",
"documentation": "A code for the type of location",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-organization",
"documentation": "Searches for locations that are managed by the provided organization",
"name": "organization",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-name",
"documentation": "A portion of the location's name or alias",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-status",
"documentation": "Searches for locations with a specific kind of status",
"name": "status",
"type": "token"
}
],
"type": "Location"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Medication",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-container",
"documentation": "E.g. box, vial, blister-pack",
"name": "container",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-package-item",
"documentation": "The item in the package",
"name": "package-item",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-code",
"documentation": "Codes that identify this medication",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-ingredient",
"documentation": "The product contained",
"name": "ingredient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-form",
"documentation": "powder | tablets | capsule +",
"name": "form",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-manufacturer",
"documentation": "Manufacturer of the item",
"name": "manufacturer",
"type": "reference"
}
],
"type": "Medication"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-identifier",
"documentation": "Return administrations with this external identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-subject",
"documentation": "The identify of the individual or group to list administrations for",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-not-given",
"documentation": "Administrations that were not made",
"name": "not-given",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-medication",
"documentation": "Return administrations of this medication resource",
"name": "medication",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-prescription",
"documentation": "The identity of a prescription to list administrations from",
"name": "prescription",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-patient",
"documentation": "The identity of a patient to list administrations for",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-effective-time",
"documentation": "Date administration happened (or did not happen)",
"name": "effective-time",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-device",
"documentation": "Return administrations with this administration device identity",
"name": "device",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"documentation": "MedicationAdministration event status (for example one of active/paused/completed/nullified)",
"name": "status",
"type": "token"
}
],
"type": "MedicationAdministration"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
],
"searchInclude": [
"MedicationRequest.encounter",
"MedicationRequest.medication",
"MedicationRequest.patient"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-date",
"documentation": "Returns medication request to be administered on a specific date",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-identifier",
"documentation": "Return prescriptions with this external identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
"documentation": "Return prescriptions written on this date",
"name": "authoredon",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-subject",
"documentation": "The identity of a patient to list orders for",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-medication",
"documentation": "Return prescriptions of this medication reference",
"name": "medication",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-patient",
"documentation": "Returns prescriptions for a specific patient",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"documentation": "Status of the prescription",
"name": "status",
"type": "token"
}
],
"type": "MedicationRequest"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
"searchInclude": [
"MessageHeader.receiver",
"MessageHeader.author",
"MessageHeader.focus",
"MessageHeader.parsed-content"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-code",
"documentation": "ok | transient-error | fatal-error",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-receiver",
"documentation": "Intended \"real-world\" recipient for the data",
"name": "receiver",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-author",
"documentation": "The source of the decision",
"name": "author",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-focus",
"documentation": "The actual content of the message",
"name": "focus",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-parsed-content",
"documentation": "Resources resulted from this message",
"name": "parsed-content",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-response-id",
"documentation": "Id of original message",
"name": "response-id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-event",
"documentation": "Code for the event this message represents",
"name": "event",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-timestamp",
"documentation": "Time that the message was sent",
"name": "timestamp",
"type": "date"
}
],
"type": "MessageHeader"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Observation",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus",
"http://hl7.org/fhir/StructureDefinition/bodyweight",
"http://hl7.org/fhir/StructureDefinition/bodytemp",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry",
"http://hl7.org/fhir/StructureDefinition/bodyheight",
"http://hl7.org/fhir/StructureDefinition/resprate",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height",
"http://hl7.org/fhir/StructureDefinition/bp",
"http://hl7.org/fhir/StructureDefinition/heartrate",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"
],
"searchInclude": [
"Observation.context",
"Observation.performer",
"Observation.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "The code of the observation type",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-subject",
"documentation": "The subject that the observation is about",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-concept",
"documentation": "The value of the observation, if the value is a CodeableConcept",
"name": "value-concept",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-date",
"documentation": "The value of the observation, if the value is a date or period of time",
"name": "value-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The subject that the observation is about (if patient)",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-specimen",
"documentation": "Specimen used for this observation",
"name": "specimen",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-string",
"documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"name": "value-string",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-performer",
"documentation": "Who performed the observation",
"name": "performer",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-quantity",
"documentation": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"name": "value-quantity",
"type": "quantity"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Encounter related to the observation",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-related-type",
"documentation": "has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by",
"name": "related-type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-related-target",
"documentation": "Resource that is related to this one",
"name": "related-target",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-category",
"documentation": "The classification of the type of observation",
"name": "category",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-status",
"documentation": "The status of the observation",
"name": "status",
"type": "token"
}
],
"type": "Observation"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Organization",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-identifier",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-partof",
"documentation": "An organization of which this organization forms a part",
"name": "partof",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address",
"documentation": "A (part of the) address of the organization",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-state",
"documentation": "A state specified in an address",
"name": "address-state",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-active",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text",
"name": "active",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-type",
"documentation": "A code for the type of organization",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-postalcode",
"documentation": "A postal code specified in an address",
"name": "address-postalcode",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-phonetic",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm",
"name": "phonetic",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-name",
"documentation": "A portion of the organization's name or alias",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-city",
"documentation": "A city specified in an address",
"name": "address-city",
"type": "string"
}
],
"type": "Organization"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Patient",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
],
"searchInclude": [
"Patient.link"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"documentation": "The patient's date of birth",
"name": "birthdate",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"documentation": "Gender of the patient",
"name": "gender",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-link",
"documentation": "All patients linked to the given patient",
"name": "link",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-language",
"documentation": "Language code (irrespective of use value)",
"name": "language",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"documentation": "The value in any kind of telecom details of the patient",
"name": "telecom",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
"documentation": "A patient identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-given",
"documentation": "A portion of the given name of the patient",
"name": "given",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-active",
"documentation": "Whether the patient record is active",
"name": "active",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-name",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-family",
"documentation": "A portion of the family name of the patient",
"name": "family",
"type": "string"
}
],
"type": "Patient"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-identifier",
"documentation": "A practitioner's Identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-given",
"documentation": "A portion of the given name",
"name": "given",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-state",
"documentation": "A state specified in an address",
"name": "address-state",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"documentation": "Gender of the practitioner",
"name": "gender",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-active",
"documentation": "Whether the practitioner record is active",
"name": "active",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"documentation": "A postalCode specified in an address",
"name": "address-postalcode",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-name",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"documentation": "The value in any kind of contact",
"name": "telecom",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-family",
"documentation": "A portion of the family name",
"name": "family",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-city",
"documentation": "A city specified in an address",
"name": "address-city",
"type": "string"
}
],
"type": "Practitioner"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
],
"searchInclude": [
"Procedure.location",
"Procedure.performer",
"Procedure.reasonreference",
"Procedure.report",
"Procedure.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Date/Period the procedure was performed",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "A code to identify a procedure",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-subject",
"documentation": "Search by subject",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Search by encounter",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-context",
"documentation": "Search by context",
"name": "context",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Search by subject - a patient",
"name": "patient",
"type": "reference"
}
],
"type": "Procedure"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "What is being requested/ordered",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"documentation": "Requested perfomer",
"name": "performer",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-subject",
"documentation": "Search by subject",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "An encounter in which this request is made",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-priority",
"documentation": "routine | urgent | asap | stat",
"name": "priority",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Search by subject - a patient",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"documentation": "draft | active | suspended | completed | entered-in-error | cancelled",
"name": "status",
"type": "token"
}
],
"type": "ServiceRequest"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-identifier",
"documentation": "An Identifier of the RelatedPerson",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"documentation": "Gender of the related person",
"name": "gender",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-patient",
"documentation": "The patient this related person is related to",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-name",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"documentation": "The value in any kind of contact",
"name": "telecom",
"type": "token"
}
],
"type": "RelatedPerson"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-identifier",
"documentation": "The unique identifier associated with the specimen",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-subject",
"documentation": "The subject of the specimen",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-patient",
"documentation": "The patient the specimen comes from",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-accession",
"documentation": "The accession number associated with the specimen",
"name": "accession",
"type": "token"
}
],
"type": "Specimen"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Substance",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-identifier",
"documentation": "Unique identifier for the substance",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-code",
"documentation": "The code of the substance or ingredient",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-quantity",
"documentation": "Amount of substance in the package",
"name": "quantity",
"type": "quantity"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-substance-reference",
"documentation": "A component of the substance",
"name": "substance-reference",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-expiry",
"documentation": "Expiry date of package or container of substance",
"name": "expiry",
"type": "date"
}
],
"type": "Substance"
},
{
"type": "Task",
"profile": "http://hl7.org/fhir/StructureDefinition/Task",
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/Task-requester",
"type": "reference",
"documentation": "Search by task requester"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Task-code",
"type": "token",
"documentation": "Search by task code"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Task-status",
"type": "token",
"documentation": "Search by task status"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Task-organization",
"type": "reference",
"documentation": "Search by responsible organization"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Task-subject",
"type": "reference",
"documentation": "Search by subject"
},
{
"name": "modified",
"definition": "http://hl7.org/fhir/SearchParameter/Task-modified",
"type": "date",
"documentation": "Search by last modification date"
}
]
}
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact",
"name": "_id",
"type": "token"
}
],
"security": {
"cors": false,
"description": "This is the Capability Statement to declare that the server supports SMART-on-FHIR. See the SMART-on-FHIR docs for the extension that would go with such a server",
"service": [
{
"coding": [
{
"code": "Certificates",
"display": "SSL where client must have a certificate registered with the server.",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service"
}
],
"text": "SSL where client must have a certificate registered with the server."
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code": "SMART-on-FHIR"
}
],
"text": "OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org)"
}
],
"extension": [
{
"extension": [
{
"url": "token",
"valueUri": "{{BaseURL}}/token"
},
{
"url": "authorize",
"valueUri": "{{BaseURL}}/authorize"
},
{
"url": "introspect",
"valueUri": "{{BaseURL}}/introspect"
}
],
"url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
}
]
}
}
],
"software": {
"name": "NXT"
},
"status": "active",
"text": {
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>NXT API FHIR Capability Statement</h2></div>",
"status": "generated"
},
"version": "1.0.0"
}Metadata EHR
Request
GET {{BaseURL}}/metadata
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"date": "2022-03-01",
"description": "NXT API conformance statement",
"fhirVersion": "4.0.1",
"format": [
"json"
],
"id": "2eec11d3-106f-4fac-8430-ae83a8b3ca7b",
"kind": "capability",
"name": "NXT API FHIR Capability Statement",
"publisher": "MedicaSoft, LLC",
"resourceType": "CapabilityStatement",
"instantiates": [
"http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data"
],
"rest": [
{
"documentation": "NXT API functionality",
"mode": "server",
"resource": [
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
],
"searchInclude": [
"AllergyIntolerance.asserter",
"AllergyIntolerance.patient",
"AllergyIntolerance.recorder"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Date record was believed accurate",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-manifestation",
"documentation": "Clinical symptoms/signs associated with the Event",
"name": "manifestation",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder",
"documentation": "Who recorded the sensitivity",
"name": "recorder",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Code that identifies the allergy or intolerance",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-criticality",
"documentation": "low | high | unable-to-assess",
"name": "criticality",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
"documentation": "active | inactive | resolved",
"name": "clinical-status",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"documentation": "allergy | intolerance - Underlying mechanism (if known)",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-onset",
"documentation": "Date(/time) when manifestations showed",
"name": "onset",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who the sensitivity is for",
"name": "patient",
"type": "reference"
}
],
"type": "AllergyIntolerance"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-date",
"documentation": "Time when the event occurred on source",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-type",
"documentation": "Type of entity involved",
"name": "entity-type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent",
"documentation": "Direct reference to resource",
"name": "agent",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-address",
"documentation": "Identifier for the network access point of the user device",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-source",
"documentation": "The identity of source detecting the event",
"name": "source",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-type",
"documentation": "Type/identifier of event",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-altid",
"documentation": "Alternative User id e.g. authentication",
"name": "altid",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-site",
"documentation": "Logical source location within the enterprise",
"name": "site",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-name",
"documentation": "Human-meaningful name for the agent",
"name": "agent-name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-subtype",
"documentation": "More specific type/id for the event",
"name": "subtype",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-patient",
"documentation": "Direct reference to resource",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-action",
"documentation": "Type of action performed during the event",
"name": "action",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-user",
"documentation": "Unique identifier for the user",
"name": "user",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity",
"documentation": "Specific instance of resource",
"name": "entity",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-id",
"documentation": "Specific instance of object",
"name": "entity-id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-outcome",
"documentation": "Whether the event succeeded or failed",
"name": "outcome",
"type": "token"
}
],
"type": "AuditEvent"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Binary",
"type": "Binary"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/CapabilityStatement",
"type": "CapabilityStatement"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Composition",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Composition editing time",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "Logical identifier of composition (version-independent)",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-subject",
"documentation": "Who and/or what the composition is about",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-author",
"documentation": "Who and/or what authored the composition",
"name": "author",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-confidentiality",
"documentation": "As defined by affinity domain",
"name": "confidentiality",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-section",
"documentation": "Classification of section (recommended)",
"name": "section",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Context of the Composition",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"documentation": "Kind of composition (LOINC if possible)",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-title",
"documentation": "Human Readable name/title",
"name": "title",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-attester",
"documentation": "Who attested the composition",
"name": "attester",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-entry",
"documentation": "A reference to data that supports this section",
"name": "entry",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who and/or what the composition is about",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-context",
"documentation": "Code(s) that apply to the event being documented",
"name": "context",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-class",
"documentation": "Categorization of Composition",
"name": "class",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Composition-status",
"documentation": "preliminary | final | amended | entered-in-error",
"name": "status",
"type": "token"
}
],
"type": "Composition"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Condition",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
],
"searchInclude": [
"Condition.asserter",
"Condition.context",
"Condition.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-severity",
"documentation": "The severity of the condition",
"name": "severity",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Code for the condition",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-evidence",
"documentation": "Manifestation/symptom",
"name": "evidence",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-subject",
"documentation": "Who has the condition?",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"documentation": "The clinical status of the condition",
"name": "clinical-status",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-encounter",
"documentation": "Encounter when condition first asserted",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-boolean",
"documentation": "Abatement boolean (boolean is true or non-boolean values are present)",
"name": "abatement-boolean",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-date",
"documentation": "Date related onsets (dateTime and Period)",
"name": "onset-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-date",
"documentation": "Date-related abatements (dateTime and period)",
"name": "abatement-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-asserter",
"documentation": "Person who asserts this condition",
"name": "asserter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-stage",
"documentation": "Simple summary (disease specific)",
"name": "stage",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who has the condition?",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-asserted-date",
"documentation": "Date record was believed accurate",
"name": "asserted-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Condition-category",
"documentation": "The category of the condition",
"name": "category",
"type": "token"
}
],
"type": "Condition"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Contract",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Contract-identifier",
"documentation": "The identity of the contract",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Contract-patient",
"documentation": "The identity of the subject of the contract (if a patient)",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Contract-subject",
"documentation": "The identity of the subject of the contract",
"name": "subject",
"type": "reference"
}
],
"type": "Contract"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage",
"searchInclude": [
"Coverage.contract"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-identifier",
"documentation": "The primary identifier of the insured and the coverage",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-subscriber",
"documentation": "Reference to the subscriber",
"name": "subscriber",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-subplan",
"documentation": "Sub-plan identifier",
"name": "subplan",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-type",
"documentation": "The kind of coverage (health plan, auto, Workers Compensation)",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-sequence",
"documentation": "Sequence number",
"name": "sequence",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-plan",
"documentation": "A plan or policy identifier",
"name": "plan",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-dependent",
"documentation": "Dependent number",
"name": "dependent",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-group",
"documentation": "Group identifier",
"name": "group",
"type": "string"
}
],
"type": "Coverage"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Device",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-udi-di",
"documentation": "The udi Device Identifier (DI)",
"name": "udi-di",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-identifier",
"documentation": "Instance id from manufacturer, owner, and others",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-device-name",
"documentation": "A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text",
"name": "device-name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-patient",
"documentation": "Patient information, if the resource is affixed to a person",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-organization",
"documentation": "The organization responsible for the device",
"name": "organization",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-model",
"documentation": "The model of the device",
"name": "model",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-location",
"documentation": "A location, where the resource is found",
"name": "location",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-type",
"documentation": "The type of the device",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-url",
"documentation": "Network address to contact device",
"name": "url",
"type": "uri"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-manufacturer",
"documentation": "The manufacturer of the device",
"name": "manufacturer",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Device-status",
"documentation": "active | inactive | entered-in-error | unknown",
"name": "status",
"type": "token"
}
],
"type": "Device"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
],
"searchInclude": [
"DiagnosticReport.context",
"DiagnosticReport.imagingstudy",
"DiagnosticReport.performer",
"DiagnosticReport.result",
"DiagnosticReport.specimen",
"DiagnosticReport.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "The clinically relevant time of the report",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "An identifier for the report",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-image",
"documentation": "A reference to the image source.",
"name": "image",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-performer",
"documentation": "Who was the source of the report (organization)",
"name": "performer",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-subject",
"documentation": "The subject of the report",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-diagnosis",
"documentation": "A coded diagnosis on the report",
"name": "diagnosis",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "The Encounter when the order was made",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-result",
"documentation": "Link to an atomic result (observation resource)",
"name": "result",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The subject of the report if a patient",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-specimen",
"documentation": "The specimen details",
"name": "specimen",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-issued",
"documentation": "When the report was issued",
"name": "issued",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
"documentation": "Which diagnostic discipline/department created the report",
"name": "category",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-status",
"documentation": "The status of the report",
"name": "status",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-interpretation",
"documentation": "The aggregated interpretation of the observation results: normal, abnormal, critical",
"name": "interpretation",
"type": "token"
}
],
"type": "DiagnosticReport"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-securitylabel",
"documentation": "Document security-tags",
"name": "securitylabel",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject",
"documentation": "Who/what is the subject of the document",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-description",
"documentation": "Human-readable description (title)",
"name": "description",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-language",
"documentation": "Human language of the content (BCP-47)",
"name": "language",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"documentation": "Kind of document (LOINC if possible)",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relation",
"documentation": "replaces | transforms | signs | appends",
"name": "relation",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who/what is the subject of the document",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"documentation": "Main clinical acts documented",
"name": "event",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-class",
"documentation": "Categorization of document",
"name": "class",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-authenticator",
"documentation": "Who/what authenticated the document",
"name": "authenticator",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "Master Version Specific Identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"documentation": "Time of service that is being documented",
"name": "period",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-custodian",
"documentation": "Organization which maintains the document",
"name": "custodian",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-indexed",
"documentation": "When this document reference was created",
"name": "indexed",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
"documentation": "Who and/or what authored the document",
"name": "author",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-created",
"documentation": "Document creation time",
"name": "created",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"documentation": "Format/content rules for the document",
"name": "format",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Context of the document content",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-location",
"documentation": "Uri where the data can be found",
"name": "location",
"type": "uri"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto",
"documentation": "Target of the relationship",
"name": "relatesto",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"documentation": "Kind of facility where patient was seen",
"name": "facility",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"documentation": "current | superseded | entered-in-error",
"name": "status",
"type": "token"
}
],
"type": "DocumentReference"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
],
"searchInclude": [
"Encounter.appointment",
"Encounter.diagnosis",
"Encounter.episodeofcare",
"Encounter.location",
"Encounter.participant",
"Encounter.service-provider",
"Encounter.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "A date within the period the Encounter lasted",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "Identifier(s) by which this encounter is known",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-episodeofcare",
"documentation": "Episode(s) of care that this encounter should be recorded against",
"name": "episodeofcare",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant-type",
"documentation": "Role of participant in encounter",
"name": "participant-type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-practitioner",
"documentation": "Persons involved in the encounter other than the patient",
"name": "practitioner",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-subject",
"documentation": "The patient ro group present at the encounter",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-length",
"documentation": "Length of encounter in days",
"name": "length",
"type": "quantity"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-diagnosis",
"documentation": "Reason the encounter takes place (resource)",
"name": "diagnosis",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-appointment",
"documentation": "The appointment that scheduled this encounter",
"name": "appointment",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant",
"documentation": "Persons involved in the encounter other than the patient",
"name": "participant",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient ro group present at the encounter",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-location-period",
"documentation": "Time period during which the patient was present at the location",
"name": "location-period",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-location",
"documentation": "Location the encounter takes place",
"name": "location",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-service-provider",
"documentation": "The custodian organization of this Encounter record",
"name": "service-provider",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement",
"documentation": "Wheelchair, translator, stretcher, etc.",
"name": "special-arrangement",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-class",
"documentation": "inpatient | outpatient | ambulatory | emergency +",
"name": "class",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-status",
"documentation": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"name": "status",
"type": "token"
}
],
"type": "Encounter"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-condition",
"documentation": "Conditions/problems/diagnoses this episode of care is for",
"name": "condition",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient who is the focus of this episode of care",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-organization",
"documentation": "The organization that has assumed the specific responsibilities of this EpisodeOfCare",
"name": "organization",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"documentation": "Type/class - e.g. specialist referral, disease management",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-care-manager",
"documentation": "Care manager/care co-ordinator for the patient",
"name": "care-manager",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-status",
"documentation": "The current status of the Episode of Care as provided (does not check the status history collection)",
"name": "status",
"type": "token"
}
],
"type": "EpisodeOfCare"
},
{
"conditionalCreate": true,
"conditionalDelete": "multiple",
"conditionalUpdate": true,
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The identity of a subject to list family member history items for",
"name": "patient",
"type": "reference"
}
],
"type": "FamilyMemberHistory"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Flag",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Flag-subject",
"documentation": "The identity of a subject to list flags for",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The identity of a subject to list flags for",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Alert relevant during encounter",
"name": "encounter",
"type": "reference"
}
],
"type": "Flag"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Goal",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who this goal is intended for",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-subject",
"documentation": "Who this goal is intended for",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-start-date",
"documentation": "When goal pursuit begins",
"name": "start-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-category",
"documentation": "E.g. Treatment, dietary, behavioral, etc.",
"name": "category",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"documentation": "Reach goal on or before",
"name": "target-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Goal-status",
"documentation": "proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected",
"name": "status",
"type": "token"
}
],
"type": "Goal"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Group",
"operation": [
{
"name": "export",
"definition": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export"
}
],
"type": "Group"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"searchInclude": [
"ImagingStudy.patient",
"ImagingStudy.performer"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-study",
"documentation": "The study identifier for the image",
"name": "study",
"type": "uri"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-dicom-class",
"documentation": "The type of the instance",
"name": "dicom-class",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-modality",
"documentation": "The modality of the series",
"name": "modality",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-bodysite",
"documentation": "The body site studied",
"name": "bodysite",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-started",
"documentation": "When the study was started",
"name": "started",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-accession",
"documentation": "The accession identifier for the study",
"name": "accession",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-uid",
"documentation": "The instance unique identifier",
"name": "uid",
"type": "uri"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Who the study is about",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-series",
"documentation": "The identifier of the series of images",
"name": "series",
"type": "token"
}
],
"type": "ImagingStudy"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
],
"searchInclude": [
"Immunization.encounter",
"Immunization.location",
"Immunization.manufacturer",
"Immunization.patient",
"Immunization.reaction"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Vaccination (non)-Administration Date",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "Business identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason",
"documentation": "Why immunization occurred",
"name": "reason",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction",
"documentation": "Additional information on reaction",
"name": "reaction",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-lot-number",
"documentation": "Vaccine Lot Number",
"name": "lot-number",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-practitioner",
"documentation": "The practitioner who played a role in the vaccination",
"name": "practitioner",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-notgiven",
"documentation": "Administrations which were not given",
"name": "notgiven",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-manufacturer",
"documentation": "Vaccine Manufacturer",
"name": "manufacturer",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-dose-sequence",
"documentation": "Dose number within series",
"name": "dose-sequence",
"type": "number"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient for the vaccination record",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code",
"documentation": "Vaccine Product Administered",
"name": "vaccine-code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason-not-given",
"documentation": "Explanation of reason vaccination was not administered",
"name": "reason-not-given",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-location",
"documentation": "The service delivery location or facility in which the vaccine was / was to be administered",
"name": "location",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction-date",
"documentation": "When reaction started",
"name": "reaction-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-status",
"documentation": "Immunization event status",
"name": "status",
"type": "token"
}
],
"type": "Immunization"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/List",
"searchInclude": [
"List.item"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "When the list was prepared",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-item",
"documentation": "Actual entry",
"name": "item",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-empty-reason",
"documentation": "Why list is empty",
"name": "empty-reason",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "What the purpose of this list is",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-subject",
"documentation": "If all resources have the same subject",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "If all resources have the same subject",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-source",
"documentation": "Who and/or what defined the list contents (aka Author)",
"name": "source",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Context in which list created",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/List-status",
"documentation": "current | retired | entered-in-error",
"name": "status",
"type": "token"
}
],
"type": "List"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Location",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-identifier",
"documentation": "An identifier for the location",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-partof",
"documentation": "A location of which this location is a part",
"name": "partof",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-address",
"documentation": "A (part of the) address of the location",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-type",
"documentation": "A code for the type of location",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-organization",
"documentation": "Searches for locations that are managed by the provided organization",
"name": "organization",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-name",
"documentation": "A portion of the location's name or alias",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Location-status",
"documentation": "Searches for locations with a specific kind of status",
"name": "status",
"type": "token"
}
],
"type": "Location"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Medication",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-container",
"documentation": "E.g. box, vial, blister-pack",
"name": "container",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-package-item",
"documentation": "The item in the package",
"name": "package-item",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-code",
"documentation": "Codes that identify this medication",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-ingredient",
"documentation": "The product contained",
"name": "ingredient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-form",
"documentation": "powder | tablets | capsule +",
"name": "form",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Medication-manufacturer",
"documentation": "Manufacturer of the item",
"name": "manufacturer",
"type": "reference"
}
],
"type": "Medication"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-identifier",
"documentation": "Return administrations with this external identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-subject",
"documentation": "The identify of the individual or group to list administrations for",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-not-given",
"documentation": "Administrations that were not made",
"name": "not-given",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-medication",
"documentation": "Return administrations of this medication resource",
"name": "medication",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-prescription",
"documentation": "The identity of a prescription to list administrations from",
"name": "prescription",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-patient",
"documentation": "The identity of a patient to list administrations for",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-effective-time",
"documentation": "Date administration happened (or did not happen)",
"name": "effective-time",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-device",
"documentation": "Return administrations with this administration device identity",
"name": "device",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"documentation": "MedicationAdministration event status (for example one of active/paused/completed/nullified)",
"name": "status",
"type": "token"
}
],
"type": "MedicationAdministration"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
],
"searchInclude": [
"MedicationRequest.encounter",
"MedicationRequest.medication",
"MedicationRequest.patient"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-date",
"documentation": "Returns medication request to be administered on a specific date",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-identifier",
"documentation": "Return prescriptions with this external identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
"documentation": "Return prescriptions written on this date",
"name": "authoredon",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-subject",
"documentation": "The identity of a patient to list orders for",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-medication",
"documentation": "Return prescriptions of this medication reference",
"name": "medication",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-patient",
"documentation": "Returns prescriptions for a specific patient",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"documentation": "Status of the prescription",
"name": "status",
"type": "token"
}
],
"type": "MedicationRequest"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
"searchInclude": [
"MessageHeader.receiver",
"MessageHeader.author",
"MessageHeader.focus",
"MessageHeader.parsed-content"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-code",
"documentation": "ok | transient-error | fatal-error",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-receiver",
"documentation": "Intended \"real-world\" recipient for the data",
"name": "receiver",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-author",
"documentation": "The source of the decision",
"name": "author",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-focus",
"documentation": "The actual content of the message",
"name": "focus",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-parsed-content",
"documentation": "Resources resulted from this message",
"name": "parsed-content",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-response-id",
"documentation": "Id of original message",
"name": "response-id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-event",
"documentation": "Code for the event this message represents",
"name": "event",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-timestamp",
"documentation": "Time that the message was sent",
"name": "timestamp",
"type": "date"
}
],
"type": "MessageHeader"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Observation",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus",
"http://hl7.org/fhir/StructureDefinition/bodyweight",
"http://hl7.org/fhir/StructureDefinition/bodytemp",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry",
"http://hl7.org/fhir/StructureDefinition/bodyheight",
"http://hl7.org/fhir/StructureDefinition/resprate",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height",
"http://hl7.org/fhir/StructureDefinition/bp",
"http://hl7.org/fhir/StructureDefinition/heartrate",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"
],
"searchInclude": [
"Observation.context",
"Observation.performer",
"Observation.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "The code of the observation type",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-subject",
"documentation": "The subject that the observation is about",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-concept",
"documentation": "The value of the observation, if the value is a CodeableConcept",
"name": "value-concept",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-date",
"documentation": "The value of the observation, if the value is a date or period of time",
"name": "value-date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The subject that the observation is about (if patient)",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-specimen",
"documentation": "Specimen used for this observation",
"name": "specimen",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-string",
"documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"name": "value-string",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-performer",
"documentation": "Who performed the observation",
"name": "performer",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-quantity",
"documentation": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"name": "value-quantity",
"type": "quantity"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Encounter related to the observation",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-related-type",
"documentation": "has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by",
"name": "related-type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-related-target",
"documentation": "Resource that is related to this one",
"name": "related-target",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-category",
"documentation": "The classification of the type of observation",
"name": "category",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Observation-status",
"documentation": "The status of the observation",
"name": "status",
"type": "token"
}
],
"type": "Observation"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Organization",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-identifier",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-partof",
"documentation": "An organization of which this organization forms a part",
"name": "partof",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address",
"documentation": "A (part of the) address of the organization",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-state",
"documentation": "A state specified in an address",
"name": "address-state",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-active",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text",
"name": "active",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-type",
"documentation": "A code for the type of organization",
"name": "type",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-postalcode",
"documentation": "A postal code specified in an address",
"name": "address-postalcode",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-phonetic",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm",
"name": "phonetic",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-name",
"documentation": "A portion of the organization's name or alias",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-city",
"documentation": "A city specified in an address",
"name": "address-city",
"type": "string"
}
],
"type": "Organization"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Patient",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
],
"searchInclude": [
"Patient.link"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"documentation": "The patient's date of birth",
"name": "birthdate",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"documentation": "Gender of the patient",
"name": "gender",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-link",
"documentation": "All patients linked to the given patient",
"name": "link",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-language",
"documentation": "Language code (irrespective of use value)",
"name": "language",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"documentation": "The value in any kind of telecom details of the patient",
"name": "telecom",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
"documentation": "A patient identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-given",
"documentation": "A portion of the given name of the patient",
"name": "given",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-active",
"documentation": "Whether the patient record is active",
"name": "active",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Patient-name",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-family",
"documentation": "A portion of the family name of the patient",
"name": "family",
"type": "string"
}
],
"type": "Patient"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-identifier",
"documentation": "A practitioner's Identifier",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-given",
"documentation": "A portion of the given name",
"name": "given",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-state",
"documentation": "A state specified in an address",
"name": "address-state",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"documentation": "Gender of the practitioner",
"name": "gender",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-active",
"documentation": "Whether the practitioner record is active",
"name": "active",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"documentation": "A postalCode specified in an address",
"name": "address-postalcode",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-name",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"documentation": "The value in any kind of contact",
"name": "telecom",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-family",
"documentation": "A portion of the family name",
"name": "family",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-city",
"documentation": "A city specified in an address",
"name": "address-city",
"type": "string"
}
],
"type": "Practitioner"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
],
"searchInclude": [
"Procedure.location",
"Procedure.performer",
"Procedure.reasonreference",
"Procedure.report",
"Procedure.subject"
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Date/Period the procedure was performed",
"name": "date",
"type": "date"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "A code to identify a procedure",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-subject",
"documentation": "Search by subject",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "Search by encounter",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-context",
"documentation": "Search by context",
"name": "context",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Search by subject - a patient",
"name": "patient",
"type": "reference"
}
],
"type": "Procedure"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "What is being requested/ordered",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"documentation": "Requested perfomer",
"name": "performer",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-subject",
"documentation": "Search by subject",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"documentation": "An encounter in which this request is made",
"name": "encounter",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-priority",
"documentation": "routine | urgent | asap | stat",
"name": "priority",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Search by subject - a patient",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"documentation": "draft | active | suspended | completed | entered-in-error | cancelled",
"name": "status",
"type": "token"
}
],
"type": "ServiceRequest"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-identifier",
"documentation": "An Identifier of the RelatedPerson",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text",
"name": "address",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"documentation": "Gender of the related person",
"name": "gender",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-patient",
"documentation": "The patient this related person is related to",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-name",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"name": "name",
"type": "string"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"documentation": "The value in any kind of contact",
"name": "telecom",
"type": "token"
}
],
"type": "RelatedPerson"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-identifier",
"documentation": "The unique identifier associated with the specimen",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-subject",
"documentation": "The subject of the specimen",
"name": "subject",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-patient",
"documentation": "The patient the specimen comes from",
"name": "patient",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-accession",
"documentation": "The accession number associated with the specimen",
"name": "accession",
"type": "token"
}
],
"type": "Specimen"
},
{
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"profile": "http://hl7.org/fhir/StructureDefinition/Substance",
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-identifier",
"documentation": "Unique identifier for the substance",
"name": "identifier",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-code",
"documentation": "The code of the substance or ingredient",
"name": "code",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-quantity",
"documentation": "Amount of substance in the package",
"name": "quantity",
"type": "quantity"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-substance-reference",
"documentation": "A component of the substance",
"name": "substance-reference",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Substance-expiry",
"documentation": "Expiry date of package or container of substance",
"name": "expiry",
"type": "date"
}
],
"type": "Substance"
},
{
"type": "Task",
"profile": "http://hl7.org/fhir/StructureDefinition/Task",
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification"
},
{
"code": "search-type",
"documentation": "Implemented per the specification"
}
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/Task-requester",
"type": "reference",
"documentation": "Search by task requester"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Task-code",
"type": "token",
"documentation": "Search by task code"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Task-status",
"type": "token",
"documentation": "Search by task status"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Task-organization",
"type": "reference",
"documentation": "Search by responsible organization"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Task-subject",
"type": "reference",
"documentation": "Search by subject"
},
{
"name": "modified",
"definition": "http://hl7.org/fhir/SearchParameter/Task-modified",
"type": "date",
"documentation": "Search by last modification date"
}
]
}
],
"searchParam": [
{
"definition": "http://hl7.org/fhir/SearchParameter/source-organization-id",
"documentation": "Code that identifies the source organization",
"name": "source_id",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/source-document",
"documentation": "Id of the source document (MessageHeader/id or DocumentReferece/id)",
"name": "source_doc",
"type": "reference"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/datamart",
"documentation": "Boolean value to filter for datamart resources",
"name": "datamart",
"type": "token"
},
{
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact",
"name": "_id",
"type": "token"
}
],
"security": {
"cors": false,
"description": "This is the Capability Statement to declare that the server supports SMART-on-FHIR. See the SMART-on-FHIR docs for the extension that would go with such a server",
"service": [
{
"coding": [
{
"code": "Certificates",
"display": "SSL where client must have a certificate registered with the server.",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service"
}
],
"text": "SSL where client must have a certificate registered with the server."
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code": "SMART-on-FHIR"
}
],
"text": "OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org)"
}
],
"extension": [
{
"extension": [
{
"url": "token",
"valueUri": "{{BaseURL}}/token"
},
{
"url": "authorize",
"valueUri": "{{BaseURL}}/authorize"
},
{
"url": "introspect",
"valueUri": "{{BaseURL}}/introspect"
}
],
"url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
}
]
}
}
],
"software": {
"name": "NXT"
},
"status": "active",
"text": {
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>NXT API FHIR Capability Statement</h2></div>",
"status": "generated"
},
"version": "1.0.0"
}Standalone Launch
The Standalone app launch is supported for patient and provider applications. Applications need to use the 3-legged O-auth flow for authorization.
For a given BaseURL, Standalone applications can use the well-known smart configuration/capability statement to discover the authorize and token endpoint.
Supported Scopes for standalone launch (Patient apps)
- openid
- fhirUser
- offline_access
- launch/patient
- patient/AllergyIntolerance.read
- patient/CarePlan.read
- patient/CareTeam.read
- patient/Condition.read
- patient/Device.read
- patient/DiagnosticReport.read
- patient/DocumentReference.read
- patient/Encounter.read
- patient/Goal.read
- patient/Immunization.read
- patient/MedicationRequest.read
- patient/Observation.read
- patient/Organization.read
- patient/Patient.read
- patient/Practitioner.read
- patient/Procedure.read
- patient/Provenance.read
Authorize Request
Method: GET
{{BaseURL}}/authorize?response_type=code&client_id={{ClientId}}&redirect_uri={{RedirectURI}}&scope={{Scope}}&state=12345&aud={{Audience}}
Query Params
| Param | Value | Description |
|---|---|---|
| response_type | code | The response type |
| client_id | {{ClientId}} | Application’s Client Id |
| redirect_uri | {{RedirectURI}} | Application’s Redirect URI |
| scope | {{Scope}} | Permissions requested |
| state | 12345 | An opaque value used by the client to maintain state between the request and callback |
| aud | {{Audience}} | FHIR Base URL (This is the same as the ‘iss’ parameter in the launch sequence) |
Examples
Authorize Request
Request
GET {{BaseURL}}/authorize?response_type=code&client_id={{ClientId}}&redirect_uri={{RedirectURI}}&scope={{Scope}}&state=12345&aud={{Audience}}
Response
302 - Found
No response body
Authorization Code From Redirect URI
Method: GET
{{RedirectURI}}?code={{AuthorizationCode}}&state=12345
Query Params
| Param | Value | Description |
|---|---|---|
| code | {{AuthorizationCode}} | The authorization code generated by the authorization server |
| state | 12345 | The exact value received from the client. |
Examples
Authorization Code From Redirect URI
Request
GET {{RedirectURI}}?code={{AuthorizationCode}}&state=12345
Response
200 - OK
No response body
Token
Token Endpoint Response Parameters
| Parameter | Optionality | Description |
|---|---|---|
| access_token | Required | access token used to retrieve FHIR resources |
| token_type | Required | will always be Bearer |
| expires_in | Required | will always be 300 seconds |
| scope | Required | permissions granted |
| id_token | Optional | included if open_id and fhir_user scopes are granted |
| refresh_token | Optional | included if offline_access scope is granted |
| patient | Optional | included if launch/patient scope is granted |
| smart_style_url | Optional | string URL where the EHR’s style parameters can be retrieved |
| need_patient_banner | Optional | will always be true |
Method: POST
{{BaseURL}}/token
Body (urlencoded)
| Param | Value | Description | Type |
|---|---|---|---|
| grant_type | authorization_code | Type of O-auth grant | text |
| code | {{AuthorizationCode}} | The authorization code generated by the authorization server | text |
| Client_id | {{ClientId}} | Application’s Client Id | text |
| Client_Secret | {{ClientSecret}} | Application’s Client Secret | text |
| Redirect_URi | {{RedirectURI}} | Application’s Redirect Uri | text |
Examples
Token Response
Request
POST {{BaseURL}}/token
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"access_token": "{{AccessToken}}",
"refresh_token": "{{RefreshToken}}",
"id_token": "{{IdToken}}",
"scope": "{{Scope}}",
"expires_in": 300,
"token_type": "Bearer",
"patient": {{PPG}},
"need_patient_banner":true,
"smart_style_url":{{smart_style_url}}
}EHR launch
Practice Fusion has support for the EHR app launch. Applications that fall under this category must provide a launch URL during app registration and must be approved to use the ‘launch’ scope.
EHR Launch Sequence
For a given application, the launch sequence is initiated by the authorizing user inside the EHR that redirects the browser to the app’s registered launch URL and passes the launch context and issuer. Using the issuer, the application is able to get the well-known smart configuration and discover the Authorize and token endpoints of the FHIR base URL, thus initiating the 3-legged O-auth workflow.
Supported Scopes for EHR launch (provider apps)
- openid
- fhirUser
- offline_access
- launch
- user/AllergyIntolerance.read
- user/CarePlan.read
- user/CareTeam.read
- user/Condition.read
- user/Device.read
- user/DiagnosticReport.read
- user/DocumentReference.read
- user/Encounter.read
- user/Goal.read
- user/Immunization.read
- user/MedicationRequest.read
- user/Observation.read
- user/Organization.read
- user/Patient.read
- user/Practitioner.read
- user/Procedure.read
- user/Provenance.read
- patient/AllergyIntolerance.read
- patient/CarePlan.read
- patient/CareTeam.read
- patient/Condition.read
- patient/Device.read
- patient/DiagnosticReport.read
- patient/DocumentReference.read
- patient/Encounter.read
- patient/Goal.read
- patient/Immunization.read
- patient/MedicationRequest.read
- patient/Observation.read
- patient/Organization.read
- patient/Patient.read
- patient/Practitioner.read
- patient/Procedure.read
- patient/Provenance.read
EHR launch
Method: GET
{{LaunchURI}}?launch=123&iss={{BaseURL}}
Query Params
| Param | Value | Description |
|---|---|---|
| launch | 123 | Opaque identifier for this specific launch, and any EHR context associated with it. This parameter must be communicated back to the EHR at authorization time by passing along a launch parameter |
| iss | {{BaseURL}} | Identifies the EHR’s FHIR endpoint, which the app can use to obtain additional details about the EHR, including its authorization URL |
Examples
EHR launch
Request
GET {{LaunchURI}}?launch=123&iss={{BaseURL}}
Response
200 - OK
No response body
Authorize Request
Method: GET
{{BaseURL}}/authorize?response_type=code&client_id={{ClientId}}&redirect_uri={{RedirectURI}}&scope={{Scope}}&state=12345&aud={{Audience}}&launch=123
Query Params
| Param | Value | Description |
|---|---|---|
| response_type | code | Should Always be code |
| client_id | {{ClientId}} | Application’s Client Id |
| redirect_uri | {{RedirectURI}} | Application’s Redirect Uri |
| scope | {{Scope}} | Permissions requested (‘Launch’ scope is required in the authorize request) |
| state | 12345 | An opaque value used by the client to maintain state between the request and callback |
| aud | {{Audience}} | FHIR Base URL (This is the same as the ‘iss’ parameter in the launch sequence) |
| launch | 123 | This must match the launch value received from the EHR |
Examples
Authorize Request
Request
GET {{BaseURL}}/authorize?response_type=code&client_id={{ClientId}}&redirect_uri={{RedirectURI}}&scope={{Scope}}&state=12345&aud={{Audience}}&launch=123
Response
302 - Found
No response body
Authorization Code From Redirect URI
Method: GET
{{RedirectURI}}?code={{AuthorizationCode}}&state=12345
Query Params
| Param | Value | Description |
|---|---|---|
| code | {{AuthorizationCode}} | The authorization code generated by the authorization server |
| state | 12345 | The exact value received from the client. |
Examples
Authorization Code From Redirect URI
Request
GET {{RedirectURI}}?code={{AuthorizationCode}}&state=12345
Response
No response body
Token
Token Endpoint Response Parameters
| Parameter | Optionality | Description |
|---|---|---|
| access_token | Required | Access token used to retrieve FHIR resources |
| token_type | Required | Will always be Bearer |
| expires_in | Required | Will always be 300 seconds |
| scope | Required | Permissions granted |
| id_token | Optional | Included if openid and fhiruser scopes are granted |
| refresh_token | Optional | included if offline_access scope is granted |
| patient | Required | Patient Context provided during launch sequence |
| smart_style_url | Optional | |
| need_patient_banner | Optional | Will always be true |
Method: POST
{{BaseURL}}/token
Body (urlencoded)
| Param | Value | Description | Type |
|---|---|---|---|
| grant_type | authorization_code | Type of O-auth grant | text |
| code | {{AuthorizationCode}} | The authorization code generated by the authorization server | text |
| Client_Id | {{ClientId}} | Application’s Client Id | text |
| Client_Secret | {{ClientSecret}} | Application’s Client Secret | text |
| Redirect_URI | {{RedirectURI}} | Application’s Redirect Uri | text |
Authentication noauth
Examples
Token Response
Request
POST {{BaseURL}}/token
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"access_token": "{{AccessToken}}",
"refresh_token": "{{RefreshToken}}",
"id_token": "{{IdToken}}",
"scope": "{{Scope}}",
"expires_in": 300,
"token_type": "Bearer",
"patient": {{PPG}},
"need_patient_banner":true,
"smart_style_url":{{smart_style_url}}
}System Apps
Practice Fusion supports the 2-legged O-auth workflow for system clients to generate an access token using the ‘Client Credentials’ grant_type.
System applications need to provide a JWKS URL during the app registration process. This URL communicates the TLS-protected endpoint where the client’s public JWK Set can be found.
Accessing FHIR resources
Obtaining an Access Token
For a given BaseURL, system applications can use the well-known smart configuration to discover the token endpoint.
Note: The practice needs to authorize system applications in the EHR before the applications can begin requesting access tokens for retrieving FHIR resources of the practice. System applications can only request scopes that have been authorized by the EHR user
Request an Access Token
Create a client assertion. A client assertion is a JWT that has the following:
- Headers:
| Parameters | Optionality | Description |
|---|---|---|
| alg | Required | JWA algorithm (e.g., RS384, ES384) used for signing the authentication JWT |
| kid | Required | identifier of the key pair used to sign this JWT; this identifier SHALL be unique within the client’s JWK Set |
| typ | Required | Fixed value: JWT |
| jku | Optional | TLS-protected URL to the JWK Set containing the public key(s) accessible without authentication or authorization. When present, this SHALL match the JWKS URL value that the client supplied to the FHIR authorization server at client registration time. When absent, the FHIR authorization server SHOULD fall back on the JWK Set URL or the JWK Set supplied at registration time. See Signature Verification for details. |
- Claims:
| Parameters | Optionality | Description |
|---|---|---|
| iss | Required | Issuer of the JWT – the client’s client_id |
| sub | Required | Same as above |
| aud | Required | FHIR Base URL’s Token Endpoint |
| exp | Required | Expiration time integer for this authentication JWT, expressed in seconds since 1970-01-01T00:00:00Z UTC - should not be > 300 seconds in the future |
| jti | Required | A nonce string value that uniquely identifies this authentication JWT. |
Supported scopes for system applications: -
- system/AllergyIntolerance.read
- system/CarePlan.read
- system/CareTeam.read
- system/Condition.read
- system/Device.read
- system/DiagnosticReport.read
- system/DocumentReference.read
- system/Encounter.read
- system/Goal.read
- system/Immunization.read
- system/MedicationRequest.read
- system/Observation.read
- system/Organization.read
- system/Patient.read
- system/Practitioner.read
- system/Procedure.read
- system/Provenance.read
Token
Token Response Parameters:
| Parameter | Optionality | Description |
|---|---|---|
| Access_token | Required | Access Token issued by the authorization server |
| token_type | Required | Will always be Bearer |
| Expires_in | Required | Duration in seconds. |
| scopes | Required | Permissions Granted |
Method: POST
{{BaseURL}}/token
Body (urlencoded)
| Param | Value | Description | Type |
|---|---|---|---|
| grant_type | client_credentials | undefined | text |
| scope | {{Scope}} | undefined | text |
| client_assertion_type | urn:ietf:params:oauth:client-assertion-type:jwt-bearer | undefined | text |
| client_assertion | {{JWT}} | undefined | text |
Examples
Token Response
Request
POST {{BaseURL}}/token
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"token_type": "Bearer",
"scope": "{{Scope}}",
"expires_in": 3600,
"access_token": "{{AccessToken}}"
}FHIR Resources
FHIR resources return USCDI V1 data classes and elements and are implemented using US Core v3.1.1 Profiles
AllergyIntolerance
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external ids for this item |
| clinicalStatus | CodeableConcept | 0..1 | active |
| verificationStatus | CodeableConcept | 1..1 | unconfirmed |
| type | code | 0..1 | allergy |
| category | code | 0..* | food |
| criticality | code | 0..1 | low |
| code | CodeableConcept | 1..1 | code that identifies the allergy or intolerance - ValueSet |
| patient | Reference | 1..1 | who the sensitivity is for |
| encounter | Reference | 0..1 | encounter when the allergy or intolerance was asserted. When allergy or intolerance was identified |
| onsetDateTime | dateTime | 0..1 | when allergy or intolerance was identified |
| onsetAge | Age | 0..1 | when allergy or intolerance was identified |
| onsetPeriod | Period | 0..1 | when allergy or intolerance was identified |
| onsetRange | Range | 0..1 | when allergy or intolerance was identified |
| onsetString | string | 0..1 | when allergy or intolerance was identified |
| recordedDate | dateTime | 0..1 | date first version of the resource instance was recorded |
| recorder | Reference | 0..1 | who recorded the sensitivity |
| asserter | Reference | 0..1 | source of the information about the allergy |
| lastOccurrence | dateTime | 0..1 | date(/time) of last known occurrence of a reaction |
| note | Annotation | 0..* | additional text not captured in other fields |
| reaction | BackboneElement | 0..* | adverse Reaction Events linked to exposure to substance |
| reaction.manifestation | CodeableConcept | 1..* | ValueSet |
Search Parameters
| Name | Type | Description |
|---|---|---|
| severity | token | mild |
| date | date | date record was believed accurate |
| manifestation | token | clinical symptoms/signs associated with the Event |
| recorder | reference | who recorded the sensitivity |
| code | token | code that identifies the allergy or intolerance |
| verification-status | token | unconfirmed |
| clinical-status | token | active |
| patient | reference | who the sensitivity is for |
| _include | AllergyIntolerance:recorder | |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
AllergyIntolerance
Method: GET
{{BaseURL}}/AllergyIntolerance
Examples
Using identifier
Request
GET {{BaseURL}}/AllergyIntolerance/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "AllergyIntolerance",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "300913006",
"display": "Shellfish allergy"
}
],
"text": "Shellfish allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
}Using search parameters
Request
GET {{BaseURL}}/AllergyIntolerance?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "c6819f53-10bf-4615-b0af-5ee5b8f7f1ae",
"meta": {
"lastUpdated": "2022-11-04T16:03:39.913+00:00"
},
"type": "searchset",
"total": 10,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/AllergyIntolerance?patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/{{ResourceId}}",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "300913006",
"display": "Shellfish allergy"
}
],
"text": "Shellfish allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/389",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "389",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "418689008",
"display": "Allergy to grass pollen"
}
],
"text": "Allergy to grass pollen"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/394",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "394",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "91935009",
"display": "Allergy to peanuts"
}
],
"text": "Allergy to peanuts"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/391",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "391",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "inactive"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "714035009",
"display": "Allergy to soya"
}
],
"text": "Allergy to soya"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/386",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "386",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "419474003",
"display": "Allergy to mould"
}
],
"text": "Allergy to mould"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/385",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "385",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "inactive"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "300916003",
"display": "Latex allergy"
}
],
"text": "Latex allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00",
"reaction": [
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "271807003",
"display": "skin rash"
}
],
"text": "skin rash"
}
]
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/387",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "387",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "232350006",
"display": "House dust mite allergy"
}
],
"text": "House dust mite allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/390",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "390",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "419263009",
"display": "Allergy to tree pollen"
}
],
"text": "Allergy to tree pollen"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/388",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "388",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "232347008",
"display": "Dander (animal) allergy"
}
],
"text": "Dander (animal) allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/AllergyIntolerance/393",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "393",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "417532002",
"display": "Allergy to fish"
}
],
"text": "Allergy to fish"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
}
]
}CarePlan
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | |
| subject | ResourceReference | 0..1 | |
| status | string | 1..1 | draft |
| period | Period | 0..1 | |
| modified | dateTime | 0..1 | |
| addresses | ResourceReference | 0..* | |
| careTeam | CarePlan.Participant | 0..* | |
| goal | ResourceReference | 0..* | |
| activity | CarePlan.Activity | 0..* | |
| notes | string | 0..1 | |
| category | CodeableConcept | 1..* | type of plan - always has at least one coding with system=http://hl7.org/fhir/us/core/CodeSystem/careplan-category, code=assess-plan |
| encounter | ResourceReference | 0..1 | |
| intent | code | 1..1 | proposal |
| text | Narrative | 1..1 | |
| text.status | code | 1..1 | generated |
Search Parameters
| Name | Type | Description |
|---|---|---|
| activity-code | token | |
| activity-date | date | |
| activity-reference | reference | |
| based-on | reference | |
| care-team | reference | |
| category | token | |
| condition | reference | |
| date | date | |
| encounter | reference | |
| goal | reference | |
| identifier | token | |
| intent | token | |
| part-of | reference | |
| patient | reference | |
| performer | reference | |
| replaces | reference | |
| status | token | |
| subject | reference | |
| _revinclude | Provenance:target |
Error Codes
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
CarePlan
Method: GET
{{BaseURL}}/CarePlan
Examples
Using identifier
Request
GET {{BaseURL}}/CarePlan/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "CarePlan",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Fracture care.<br/>Activities: <ul><li>Fracture care</li><li>Fracture care</li></ul><br/>Care plan is meant to treat Fracture of clavicle.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385691007",
"display": "Fracture care"
}
],
"text": "Fracture care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/145"
},
"period": {
"start": "1946-11-23T01:11:45-05:00",
"end": "1947-01-22T01:11:45-05:00"
},
"careTeam": [
{
"reference": "CareTeam/148"
}
],
"addresses": [
{
"reference": "Condition/146"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183051005",
"display": "Recommendation to rest"
}
],
"text": "Recommendation to rest"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "408580007",
"display": "Physical activity target light exercise"
}
],
"text": "Physical activity target light exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
}Using search parameters
Request
GET {{BaseURL}}/CarePlan?category=assess-plan&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "f410b714-bc58-467c-b4fb-21b3f00888e9",
"meta": {
"lastUpdated": "2022-11-04T16:03:14.807+00:00"
},
"type": "searchset",
"total": 6,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/CarePlan?category=assess-plan&patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/CarePlan/{{ResourceId}}",
"resource": {
"resourceType": "CarePlan",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Fracture care.<br/>Activities: <ul><li>Fracture care</li><li>Fracture care</li></ul><br/>Care plan is meant to treat Fracture of clavicle.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385691007",
"display": "Fracture care"
}
],
"text": "Fracture care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/145"
},
"period": {
"start": "1946-11-23T01:11:45-05:00",
"end": "1947-01-22T01:11:45-05:00"
},
"careTeam": [
{
"reference": "CareTeam/148"
}
],
"addresses": [
{
"reference": "Condition/146"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183051005",
"display": "Recommendation to rest"
}
],
"text": "Recommendation to rest"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "408580007",
"display": "Physical activity target light exercise"
}
],
"text": "Physical activity target light exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/CarePlan/211",
"resource": {
"resourceType": "CarePlan",
"id": "211",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/207"
},
"period": {
"start": "1958-12-21T00:11:45-05:00",
"end": "1959-05-29T01:11:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/210"
}
],
"addresses": [
{
"reference": "Condition/208"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/CarePlan/307",
"resource": {
"resourceType": "CarePlan",
"id": "307",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Inpatient care plan (record artifact).<br/>Activities: <ul><li>Inpatient care plan (record artifact)</li><li>Inpatient care plan (record artifact)</li></ul><br/>Care plan is meant to treat Chronic congestive heart failure (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "736353004",
"display": "Inpatient care plan (record artifact)"
}
],
"text": "Inpatient care plan (record artifact)"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/301"
},
"period": {
"start": "1977-03-28T02:25:45-05:00",
"end": "1977-03-30T03:17:45-05:00"
},
"careTeam": [
{
"reference": "CareTeam/306"
}
],
"addresses": [
{
"reference": "Condition/260"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385715006",
"display": "Cardiac care (regime/therapy)"
}
],
"text": "Cardiac care (regime/therapy)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386619000",
"display": "Low sodium diet (finding)"
}
],
"text": "Low sodium diet (finding)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/CarePlan/284",
"resource": {
"resourceType": "CarePlan",
"id": "284",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Inpatient care plan (record artifact).<br/>Activities: <ul><li>Inpatient care plan (record artifact)</li><li>Inpatient care plan (record artifact)</li></ul><br/>Care plan is meant to treat Chronic congestive heart failure (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "736353004",
"display": "Inpatient care plan (record artifact)"
}
],
"text": "Inpatient care plan (record artifact)"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"period": {
"start": "1975-04-07T02:42:45-04:00",
"end": "1975-04-08T03:25:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/283"
}
],
"addresses": [
{
"reference": "Condition/260"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385715006",
"display": "Cardiac care (regime/therapy)"
}
],
"text": "Cardiac care (regime/therapy)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386619000",
"display": "Low sodium diet (finding)"
}
],
"text": "Low sodium diet (finding)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/CarePlan/235",
"resource": {
"resourceType": "CarePlan",
"id": "235",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/231"
},
"period": {
"start": "1964-02-03T00:17:45-05:00",
"end": "1965-06-04T01:11:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/234"
}
],
"addresses": [
{
"reference": "Condition/208"
},
{
"reference": "Condition/232"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/CarePlan/267",
"resource": {
"resourceType": "CarePlan",
"id": "267",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Heart failure self management plan.<br/>Activities: <ul><li>Heart failure self management plan</li><li>Heart failure self management plan</li></ul><br/>Care plan is meant to treat Chronic congestive heart failure (disorder).</div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "735984001",
"display": "Heart failure self management plan"
}
],
"text": "Heart failure self management plan"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/263"
},
"period": {
"start": "1974-04-12T02:42:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/266"
}
],
"addresses": [
{
"reference": "Condition/260"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183063000",
"display": "low salt diet education"
}
],
"text": "low salt diet education"
},
"status": "in-progress",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183301007",
"display": "physical exercise"
}
],
"text": "physical exercise"
},
"status": "in-progress",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
}
]
}CareTeam
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external Ids for this team |
| status | code | 1..1 | proposed |
| category | CodeableConcept | 0..* | type of team |
| name | string | 0..1 | name of the team, such as the crisis assessment team |
| subject | ResourceReference | 1..1 | who care team is for |
| period | Period | 0..1 | time period team covers |
| participant | CareTeam.Participant | 1..* | members of the team |
| participant.role | CodeableConcept | 1..1 | type of involvement - Binding |
| participant.member | Reference(US Core Patient Profile | US Core Practitioner Profile | 1..1 |
| managingOrganization | ResourceReference | 0..1 | organization responsible for the care team |
| encounter | ResourceReference | 0..1 | encounter created as part of |
| reasonCode | CodeableConcept | 0..* | time period of participant |
Search Parameters
| Name | Type | Description |
|---|---|---|
| category | token | |
| date | date | |
| encounter | reference | |
| identifier | token | |
| participant | reference | |
| patient | reference | |
| status | token | |
| subject | reference | |
| _revinclude | Provenance:target |
Error Codes
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
CareTeam
Method: GET
{{BaseURL}}/CareTeam
Examples
Using identifier
Request
GET {{BaseURL}}/CareTeam/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "CareTeam",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
]
},
"status": "active",
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/263"
},
"period": {
"start": "1974-04-12T02:42:45-04:00"
},
"participant": [
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "116154003",
"display": "Patient"
}
],
"text": "Patient"
}
],
"member": {
"reference": "Patient/{{PPG}}",
"display": "Mr. Lucien408 Bosco882"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "223366009",
"display": "Healthcare professional (occupation)"
}
],
"text": "Healthcare professional (occupation)"
}
],
"member": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "224891009",
"display": "Healthcare services (qualifier value)"
}
],
"text": "Healthcare services (qualifier value)"
}
],
"member": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
}
}
],
"reasonCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
}
],
"managingOrganization": [
{
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
}
]
}Using search parameters
Request
GET {{BaseURL}}/CareTeam?patient={{PPG}}&status=active
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "2482059a-4266-4ecf-b55b-ea36dbd9c134",
"meta": {
"lastUpdated": "2022-11-04T16:03:15.410+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/CareTeam?patient={{PPG}}&status=active"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/CareTeam/{{ResourceId}}",
"resource": {
"resourceType": "CareTeam",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
]
},
"status": "active",
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/263"
},
"period": {
"start": "1974-04-12T02:42:45-04:00"
},
"participant": [
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "116154003",
"display": "Patient"
}
],
"text": "Patient"
}
],
"member": {
"reference": "Patient/{{PPG}}",
"display": "Mr. Lucien408 Bosco882"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "223366009",
"display": "Healthcare professional (occupation)"
}
],
"text": "Healthcare professional (occupation)"
}
],
"member": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "224891009",
"display": "Healthcare services (qualifier value)"
}
],
"text": "Healthcare services (qualifier value)"
}
],
"member": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
}
}
],
"reasonCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
}
],
"managingOrganization": [
{
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
}
]
},
"search": {
"mode": "match"
}
}
]
}Condition
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external Ids for this condition |
| clinicalStatus | CodeableConcept | 0..1 | active |
| verificationStatus | CodeableConcept | 0..1 | provisional |
| category | CodeableConcept | 1..* | problem-list-item |
| encounter | Reference | 0..1 | encounter created as part of |
| severity | CodeableConcept | 0..1 | subjective severity of condition |
| code | CodeableConcept | 1..1 | identification of the condition, problem or diagnosis - Binding |
| bodySite | CodeableConcept | 0..* | anatomical location, if relevant |
| subject | Reference(US Core Patient Profile) | 1..1 | who has the condition |
| onsetDateTime | dateTime | 0..1 | estimated or actual date, date-time, or age |
| onsetAge | Age | 0..1 | estimated or actual date, date-time, or age |
| onsetPeriod | Period | 0..1 | estimated or actual date, date-time, or age |
| onsetRange | Range | 0..1 | estimated or actual date, date-time, or age |
| onsetString | string | 0..1 | estimated or actual date, date-time, or age |
| abatementDateTime | dateTime | 0..1 | if/when in resolution/remission |
| abatementAge | Age | 0..1 | if/when in resolution/remission |
| abatementPeriod | Period | 0..1 | if/when in resolution/remission |
| abatementRange | Range | 0..1 | if/when in resolution/remission |
| abatementString | string | 0..1 | if/when in resolution/remission |
| recordedDate | dateTime | 0..1 | date record was believed accurate |
| recorder | Reference | 0..1 | person who asserts this condition |
| asserter | Reference | 0..1 | person who asserts this condition |
| stage | BackboneElement | 0..* | stage/grade, usually assessed formally |
| evidence | BackboneElement | 0..* | supporting evidence |
| note | Annotation | 0..* | additional information about the Condition |
Search Parameters
| Name | Type | Description |
|---|---|---|
| severity | token | the severity of the condition |
| code | token | code for the condition |
| evidence | token | manifestation/symptom |
| subject | reference | who has the condition |
| clinical-status | token | the clinical status of the condition |
| encounter | reference | encounter when condition first asserted |
| abatement-boolean | token | abatement boolean (boolean is true or non-boolean values are present) |
| onset-date | date | date related onsets (dateTime and Period) |
| abatement-date | date | date-related abatements (dateTime and period) |
| asserter | reference | person who asserts this condition |
| stage | token | simple summary (disease specific) |
| patient | reference | who has the condition |
| context | reference | encounter or episode when condition first asserted |
| recorded-date | date | date record was believed accurate |
| category | token | the category of the condition |
| _include | undefined | condition:subject |
| _revinclude | provenance:target |
Error Codes
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Condition
Method: GET
{{BaseURL}}/Condition
Examples
Using identifier
Request
GET {{BaseURL}}/Condition/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Condition",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/259"
},
"onsetDateTime": "1974-03-29T01:11:45-04:00",
"recordedDate": "1974-03-29T01:11:45-04:00"
}Using search parameters
Request
GET {{BaseURL}}/Condition?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "9c1f35ee-29fb-4b25-8436-1d8f89e603da",
"meta": {
"lastUpdated": "2022-11-04T16:03:16.261+00:00"
},
"type": "searchset",
"total": 13,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/Condition?patient={{PPG}}"
},
{
"relation": "next",
"url": "{{BaseURL}}?_getpages=9c1f35ee-29fb-4b25-8436-1d8f89e603da&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/Condition/{{ResourceId}}",
"resource": {
"resourceType": "Condition",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/259"
},
"onsetDateTime": "1974-03-29T01:11:45-04:00",
"recordedDate": "1974-03-29T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Condition/220",
"resource": {
"resourceType": "Condition",
"id": "220",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unknown"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "195662009",
"display": "Acute viral pharyngitis (disorder)"
}
],
"text": "Acute viral pharyngitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/219"
},
"onsetDateTime": "1961-06-25T01:11:45-04:00",
"abatementDateTime": "1961-07-07T01:11:45-04:00",
"recordedDate": "1961-06-25T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Condition/111",
"resource": {
"resourceType": "Condition",
"id": "111",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "195662009",
"display": "Acute viral pharyngitis (disorder)"
}
],
"text": "Acute viral pharyngitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/110"
},
"onsetDateTime": "1941-01-26T00:11:45-05:00",
"abatementDateTime": "1941-02-06T00:11:45-05:00",
"recordedDate": "1941-01-26T00:11:45-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Condition/208",
"resource": {
"resourceType": "Condition",
"id": "208",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "10509002",
"display": "Acute bronchitis (disorder)"
}
],
"text": "Acute bronchitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/207"
},
"onsetDateTime": "1958-12-21T00:11:45-05:00",
"abatementDateTime": "1958-12-28T00:11:45-05:00",
"recordedDate": "1958-12-21T00:11:45-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Condition/176",
"resource": {
"resourceType": "Condition",
"id": "176",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "444814009",
"display": "Viral sinusitis (disorder)"
}
],
"text": "Viral sinusitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/175"
},
"onsetDateTime": "1951-09-04T01:11:45-04:00",
"abatementDateTime": "1951-09-18T01:11:45-04:00",
"recordedDate": "1951-09-04T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Condition/251",
"resource": {
"resourceType": "Condition",
"id": "251",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "195662009",
"display": "Acute viral pharyngitis (disorder)"
}
],
"text": "Acute viral pharyngitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/250"
},
"onsetDateTime": "1969-10-08T01:11:45-04:00",
"abatementDateTime": "1969-10-15T01:11:45-04:00",
"recordedDate": "1969-10-08T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Condition/158",
"resource": {
"resourceType": "Condition",
"id": "158",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "65363002",
"display": "Otitis media"
}
],
"text": "Otitis media"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/157"
},
"onsetDateTime": "1947-11-01T00:11:45-05:00",
"abatementDateTime": "1948-03-26T00:11:45-05:00",
"recordedDate": "1947-11-01T00:11:45-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Condition/249",
"resource": {
"resourceType": "Condition",
"id": "249",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "444814009",
"display": "Viral sinusitis (disorder)"
}
],
"text": "Viral sinusitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/248"
},
"onsetDateTime": "1969-06-22T01:11:45-04:00",
"abatementDateTime": "1969-07-06T01:11:45-04:00",
"recordedDate": "1969-06-22T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Condition/258",
"resource": {
"resourceType": "Condition",
"id": "258",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "195662009",
"display": "Acute viral pharyngitis (disorder)"
}
],
"text": "Acute viral pharyngitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/257"
},
"onsetDateTime": "1972-03-05T00:11:45-05:00",
"abatementDateTime": "1972-03-13T00:11:45-05:00",
"recordedDate": "1972-03-05T00:11:45-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Condition/108",
"resource": {
"resourceType": "Condition",
"id": "108",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "65363002",
"display": "Otitis media"
}
],
"text": "Otitis media"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/107"
},
"onsetDateTime": "1940-12-24T00:11:45-05:00",
"abatementDateTime": "1941-03-07T00:11:45-05:00",
"recordedDate": "1940-12-24T00:11:45-05:00"
},
"search": {
"mode": "match"
}
}
]
}Device
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | instance identifier |
| definition | Reference | 0..1 | the reference to the definition for the device |
| udiCarrier | BackboneElement | 0..1 | Unique Device Identifier (UDI) Barcode string |
| udiCarrier.deviceIdentifier | string | 1..1 | mandatory fixed portion of UDI |
| udiCarrier.carrierAIDC | base64Binary | 0..1 | UDI Machine Readable Barcode String |
| udiCarrier.carrierHRF | string | 0..1 | UDI Human Readable Barcode String |
| status | code | 0..1 | active |
| statusReason | CodeableConcept | 0..* | online |
| distinctIdentifier | string | 0..1 | the distinct identification string |
| manufacturer | string | 0..1 | name of device manufacturer |
| manufactureDate | dateTime | 0..1 | date when the device was made |
| expirationDate | dateTime | 0..1 | date and time of expiry of this device (if applicable) |
| lotNumber | string | 0..1 | lot number of manufacture |
| serialNumber | string | 0..1 | serial number assigned by the manufacturer |
| deviceName | BackboneElement | 0..* | the name of the device as given by the manufacturer |
| modelNumber | string | 0..1 | the model number for the device |
| partNumber | string | 0..1 | the part number of the device |
| type | CodeableConcept | 1..1 | the kind or type of device - Binding |
| specialization | BackboneElement | 0..* | the capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication |
| version | BackboneElement | 0..* | the actual design of the device or software version running on the device |
| property | BackboneElement | 0..* | the actual configuration settings of a device as it actually operates, e.g., regulation status, time properties |
| patient | Reference(US Core Patient Profile) | 1..1 | patient to whom Device is affixed |
| owner | Reference | 0..1 | organization responsible for device |
| contact | ContactPoint | 0..* | details for human/organization for support |
| location | Reference | 0..1 | where the resource is found |
| url | uri | 0..1 | network address to contact device |
| note | Annotation | 0..* | device notes and comments |
| safety | CodeableConcept | 0..* | Safety Characteristics of Device |
| parent | Reference | 0..1 | the reference to the definition for the device |
Search Parameters
| Name | Type | Description |
|---|---|---|
| udi-di | string | The udi Device Identifier (DI) |
| identifier | token | instance id from manufacturer, owner, and others |
| device-name | string | a server-defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text |
| patient | reference | patient information, if the resource is affixed to a person |
| organization | reference | the organization responsible for the device |
| model | string | the model of the device |
| location | reference | a location, where the resource is found |
| type | token | the type of the device |
| url | uri | network address to contact device |
| manufacturer | string | the manufacturer of the device |
| status | token | active |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Device
Method: GET
{{BaseURL}}/Device
Examples
Using identifier
Request
GET {{BaseURL}}/Device/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Device",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
]
},
"udiCarrier": [
{
"deviceIdentifier": "43069338026389",
"carrierHRF": "(01)43069338026389(11)000302(17)250317(10)1134(21)842026117977"
}
],
"status": "active",
"distinctIdentifier": "43069338026389",
"manufactureDate": "2000-03-02T18:33:18-05:00",
"expirationDate": "2025-03-17T19:33:18-04:00",
"lotNumber": "1134",
"serialNumber": "842026117977",
"deviceName": [
{
"name": "Implantable defibrillator, device (physical object)",
"type": "user-friendly-name"
}
],
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "72506001",
"display": "Implantable defibrillator, device (physical object)"
}
],
"text": "Implantable defibrillator, device (physical object)"
},
"patient": {
"reference": "Patient/{{PPG}}"
}
}Using search parameter
Request
GET {{BaseURL}}/Device?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "9e09672d-a83e-4dbd-8697-9d61549f0aa9",
"meta": {
"lastUpdated": "2022-11-04T16:03:45.057+00:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/Device?patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/Device/{{ResourceId}}",
"resource": {
"resourceType": "Device",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
]
},
"udiCarrier": [
{
"deviceIdentifier": "43069338026389",
"carrierHRF": "(01)43069338026389(11)000302(17)250317(10)1134(21)842026117977"
}
],
"status": "active",
"distinctIdentifier": "43069338026389",
"manufactureDate": "2000-03-02T18:33:18-05:00",
"expirationDate": "2025-03-17T19:33:18-04:00",
"lotNumber": "1134",
"serialNumber": "842026117977",
"deviceName": [
{
"name": "Implantable defibrillator, device (physical object)",
"type": "user-friendly-name"
}
],
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "72506001",
"display": "Implantable defibrillator, device (physical object)"
}
],
"text": "Implantable defibrillator, device (physical object)"
},
"patient": {
"reference": "Patient/{{PPG}}"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Device/793",
"resource": {
"resourceType": "Device",
"id": "793",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
]
},
"udiCarrier": [
{
"deviceIdentifier": "43069338026389",
"carrierAIDC": "iVBORw0KGgoAAAANSUhEUgAAAioAAAB2CAIAAABpgS9BAAADHUlEQVR42u3aXY+iMBiAUbrZ//+XuxcmpunXvkABNedczahAReWZdkxbIee8bVtK6f3zS3tLaXTv6/b5nttHtuMZHaW8JXJvu8/4GNp72+NGxhN5jvPnHn8tInubn4fIfiKjHZ35+fth1bM49g4/dpaOfWrOnMk7X829449/ciOfzcjrFX/FV73f4sfdexWdv8fOvB9G17T4FW/+WkfOw8ufDQBuJz8AyA8A8gMA8gOA/ACA/AAgPwAgPwDIDwDIDwDyA4D8AID8ACA/ACA/AMgPAMgPAPIDAPIDgPwAID8AID8AyA8AyA8A8gMA8gOA/ACA/AAgPwDIDwDIDwDyAwDyA4D8AID8ACA/ACA/AMgPAPIDAPIDgPwAgPwAID8AID8AyA8AyA8A8gOA/ACA/AAgPwAgPwDIDwDIDwDyAwDyA4D8ACA/ACA/AMgPAMgPAPIDAPIDgPwAgPwAID8AyA8AyA8A8gMA8gOA/ACA/AAgPwAgPwDIDwDyAwDyA4D8AID8ACA/ACA/AMgPAMgPAPIDgPw4BQDIDwDyAwDyA4D8AID8ACA/ACA/AMgPAMgPAPIDgPwAgPwAID8AID8AfJuUc3YWADD7AUB+AOACf50CrpBSqm65dJn3dbgDhyjHeWaEKS1bx141pAefAsgPT7rzWpZzboO3d5yfc/39wCHBchbfYGXDPmdIYPYDW/dv+fev3eWm93pa+bDycjy/4p9cwhoNafRzdZTJM9o1pPYo5eajExI/evdkPrX6h/zAstgEO9FtUtmeqkDdDYP7PJPJ4Bylu/mufXaLMip39Zj40bttO3nqQH54XnvZ6oZk19XtGy+FB8bcVme0k//uPHh0q3zID7/fpPlS1fK518LN29nY1UOqgn1Pm3UI+eEHtbOfdrXnqTnH1dOshV/svrQQVtu4h2++8UB7tqOrPccuu8GtRnOa6l/xB/6TtHxIVzx3MyHMfvid2ET+pp53qNpq/kWv97Jetc/gd+RGaQxuPj/62iHN5y7Bo1cns/yqoZkQd1wivL34xskT8O0svgFg9gOA2Q8AyA8Av+MfJjJq5w+06kcAAAAASUVORK5CYII="
}
],
"status": "active",
"distinctIdentifier": "43069338026389",
"manufactureDate": "2000-03-02T18:33:18-05:00",
"expirationDate": "2025-03-17T19:33:18-04:00",
"lotNumber": "1134",
"serialNumber": "842026117977",
"deviceName": [
{
"name": "Implantable defibrillator, device (physical object)",
"type": "user-friendly-name"
}
],
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "72506001",
"display": "Implantable defibrillator, device (physical object)"
}
],
"text": "Implantable defibrillator, device (physical object)"
},
"patient": {
"reference": "Patient/{{PPG}}"
}
},
"search": {
"mode": "match"
}
}
]
}DiagnosticReport
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | business identifier for report |
| basedOn | Reference | 0..* | what was requested |
| status | code | 1..1 | registered |
| category | CodeableConcept | 1..* | service category |
| encounter | Reference(US Core Encounter Profile) | 0..1 | the healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about |
| code | CodeableConcept | 1..1 | name/Code for this diagnostic report |
| subject | Reference(US Core Patient Profile) | 1..1 | the subject of the report - usually, but not always, the patient |
| effectiveDateTime | dateTime | 1..1 | clinically relevant time/time-period for report - either effactiveDateTime or effectivePeriod should be provided |
| effectivePeriod | Period | 1..1 | clinically relevant time/time-period for report - either effactiveDateTime or effectivePeriod should be provided |
| issued | instant | 1..1 | dateTime this version was released |
| performer | Reference(US Core Practitioner Profile | US Core Organization Profile) | 0..* |
| resultsInterpreter | Reference | 0..* | the practitioner or organization that is responsible for the report’s conclusions and interpretations. |
| specimen | Reference | 0..* | specimens this report is based on |
| result | Reference(US Core Laboratory Result Observation Profile) | 0..* | observations - simple, or complex nested groups |
| imagingStudy | Reference | 0..* | reference to full details of imaging associated with the diagnostic report |
| media | BackboneElement | 0..* | key images associated with this report |
| conclusion | string | 0..1 | Clinical Interpretation of test results |
| conslusionCode | CodeableConcept | 0..* | codes for the conclusion |
| presentedForm | Attachment | 0..* | entire report as issued |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | the clinically relevant time of the report |
| identifier | token | an identifier for the report |
| media | reference | a reference to the image source |
| performer | reference | who was the source of the report (organization) |
| code | token | the code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
| results-interpreter | reference | who was the source of the report |
| subject | reference | the subject of the report |
| diagnosis | token | a coded diagnosis on the report |
| encounter | reference | the encounter when the order was made |
| encounter-class | token | |
| result | reference | link to an atomic result (observation resource) |
| based-on | reference | reference to the procedure request. |
| patient | reference | the subject of the report if a patient |
| specimen | reference | the specimen details |
| context | reference | healthcare event (Episode of Care or Encounter) related to the report |
| issued | date | when the report was issued |
| category | token | which diagnostic discipline/department created the report |
| status | token | the status of the report |
| requester-id | string | |
| _include | undefined | DiagnosticReport:performer |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Profiles
DiagnosticReport Profile for Laboratory Results Reporting
On top of the other constraints, a DiagnosticReport for Laboratory Results Reporting must have:
- one entry in the
categoryarray havingsystem = http://terminology.hl7.org/CodeSystem/v2-0074,code = LAB - the result values should be coded as
Observationentries and referenced in theresultfield
DiagnosticReport Profile for Report and Note exchange
On top of the other constraints, a DiagnosticReport for Laboratory Results Reporting must have:
- a
codedescribing the type of report from US Core Diagnosticreport Report And Note Codes - a
categorycode from US Core DiagnosticReport Category - a reference to the fullReport (Narrative) in the
presentedFormfield
The system supports the following clinical note categories:
- History & Physical Note (34117-2)
and the following DiagnosticReport categories:
- Cardiology / Laboratory Report (LP29708-2)
- Pathology Report (LP7839-6)
- Radiology / Imaging Narrative (LP29684-5)
DiagnosticReport
Method: GET
{{BaseURL}}/DiagnosticReport
Examples
Using Identifier
Request
GET {{BaseURL}}/DiagnosticReport/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "DiagnosticReport",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Physical note"
}
],
"text": "History & Physical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/202"
},
"effectiveDateTime": "1958-05-23T01:11:45-04:00",
"issued": "1958-05-23T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NTgtMDUtMjMKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE4IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQ7IGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK"
}
]
}Using Report/Note exchange
Request
GET {{BaseURL}}/DiagnosticReport?patient={{PPG}}&category=LP29684-5
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "0f9fc14a-f548-40dc-855f-82123a9b79b6",
"meta": {
"lastUpdated": "2022-11-04T16:03:17.102+00:00"
},
"type": "searchset",
"total": 7,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/DiagnosticReport?category=LP29684-5&patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/DiagnosticReport/{{ResourceId}}",
"resource": {
"resourceType": "DiagnosticReport",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Physical note"
}
],
"text": "History & Physical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/202"
},
"effectiveDateTime": "1958-05-23T01:11:45-04:00",
"issued": "1958-05-23T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NTgtMDUtMjMKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE4IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQ7IGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DiagnosticReport/179",
"resource": {
"resourceType": "DiagnosticReport",
"id": "179",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/175"
},
"effectiveDateTime": "1951-09-04T01:11:45-04:00",
"issued": "1951-09-04T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NTEtMDktMDQKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDExIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZS4KCiMgU29jaWFsIEhpc3RvcnkKIFBhdGllbnQgaGFzIG5ldmVyIHNtb2tlZCBhbmQgaXMgYW4gYWxjb2hvbGljLgoKUGF0aWVudCBjb21lcyBmcm9tIGEgaGlnaCBzb2Npb2Vjb25vbWljIGJhY2tncm91bmQuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgpQYXRpZW50IGlzIHByZXNlbnRpbmcgd2l0aCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4gCgojIyBQbGFuCgpUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gbWVkaWNhdGlvbiByZWNvbmNpbGlhdGlvbiAocHJvY2VkdXJlKQpUaGUgcGF0aWVudCB3YXMgcHJlc2NyaWJlZCB0aGUgZm9sbG93aW5nIG1lZGljYXRpb25zOgotIGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAo="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DiagnosticReport/221",
"resource": {
"resourceType": "DiagnosticReport",
"id": "221",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/219"
},
"effectiveDateTime": "1961-06-25T01:11:45-04:00",
"issued": "1961-06-25T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NjEtMDYtMjUKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDIxIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDIxLjcgbWcvbWwgLyBkZXh0cm9tZXRob3JwaGFuIGh5ZHJvYnJvbWlkZSAxIG1nL21sIC8gZG94eWxhbWluZSBzdWNjaW5hdGUgMC40MTcgbWcvbWwgb3JhbCBzb2x1dGlvbjsgcGVuaWNpbGxpbiBnIDM3NSBtZy9tbCBpbmplY3RhYmxlIHNvbHV0aW9uOyBhc3BpcmluIDgxIG1nIG9yYWwgdGFibGV0OyBhbW94aWNpbGxpbiAyNTAgbWcgLyBjbGF2dWxhbmF0ZSAxMjUgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgpQYXRpZW50IGlzIHByZXNlbnRpbmcgd2l0aCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLiAKCiMjIFBsYW4KCg=="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DiagnosticReport/99",
"resource": {
"resourceType": "DiagnosticReport",
"id": "99",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/96"
},
"effectiveDateTime": "1940-09-06T01:11:45-04:00",
"issued": "1940-09-06T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NDAtMDktMDYKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDUgbW9udGgtb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCk5vIEFjdGl2ZSBNZWRpY2F0aW9ucy4KCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg=="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DiagnosticReport/155",
"resource": {
"resourceType": "DiagnosticReport",
"id": "155",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History and physical note"
}
],
"text": "History and physical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/153"
},
"effectiveDateTime": "1947-03-21T00:11:45-05:00",
"issued": "1947-03-21T00:11:45.131-05:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NDctMDMtMjEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDYgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCmFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KUGF0aWVudCB3YXMgZ2l2ZW4gdGhlIGZvbGxvd2luZyBpbW11bml6YXRpb25zOiBpbmZsdWVuemEsIHNlYXNvbmFsLCBpbmplY3RhYmxlLCBwcmVzZXJ2YXRpdmUgZnJlZS4gCg=="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DiagnosticReport/255",
"resource": {
"resourceType": "DiagnosticReport",
"id": "255",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/252"
},
"effectiveDateTime": "1971-06-11T01:11:45-04:00",
"issued": "1971-06-11T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NzEtMDYtMTEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDMxIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDMyNSBtZyBvcmFsIHRhYmxldDsgYWNldGFtaW5vcGhlbiAyMS43IG1nL21sIC8gZGV4dHJvbWV0aG9ycGhhbiBoeWRyb2Jyb21pZGUgMSBtZy9tbCAvIGRveHlsYW1pbmUgc3VjY2luYXRlIDAuNDE3IG1nL21sIG9yYWwgc29sdXRpb247IHBlbmljaWxsaW4gZyAzNzUgbWcvbWwgaW5qZWN0YWJsZSBzb2x1dGlvbjsgYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldDsgYW1veGljaWxsaW4gMjUwIG1nIC8gY2xhdnVsYW5hdGUgMTI1IG1nIG9yYWwgdGFibGV0CgojIEFzc2Vzc21lbnQgYW5kIFBsYW4KCgojIyBQbGFuClBhdGllbnQgd2FzIGdpdmVuIHRoZSBmb2xsb3dpbmcgaW1tdW5pemF0aW9uczogaW5mbHVlbnphLCBzZWFzb25hbCwgaW5qZWN0YWJsZSwgcHJlc2VydmF0aXZlIGZyZWUuIApUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gbWVkaWNhdGlvbiByZWNvbmNpbGlhdGlvbiAocHJvY2VkdXJlKQo="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DiagnosticReport/123",
"resource": {
"resourceType": "DiagnosticReport",
"id": "123",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/120"
},
"effectiveDateTime": "1941-09-05T01:11:45-04:00",
"issued": "1941-09-05T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NDEtMDktMDUKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDEgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGhhcyBuZXZlciBzbW9rZWQgYW5kIGlzIGFuIGFsY29ob2xpYy4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGN1cnJlbnRseSBoYXMgQmx1ZSBDcm9zcyBCbHVlIFNoaWVsZC4KCiMgQWxsZXJnaWVzCk5vIEtub3duIEFsbGVyZ2llcy4KCiMgTWVkaWNhdGlvbnMKYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgoKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK"
}
]
},
"search": {
"mode": "match"
}
}
]
}Using LAB category
Request
GET {{BaseURL}}/DiagnosticReport?category=LAB&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "6444129f-3766-488e-bdba-e657dff2b180",
"meta": {
"lastUpdated": "2022-11-04T16:03:48.311+00:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/DiagnosticReport?category=LAB&patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/DiagnosticReport/{{ResourceId}}",
"resource": {
"resourceType": "DiagnosticReport",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0074",
"code": "LAB",
"display": "Laboratory"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "51990-0",
"display": "Basic Metabolic Panel"
}
],
"text": "Basic Metabolic Panel"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/744"
},
"effectiveDateTime": "2017-09-28T19:33:18-04:00",
"issued": "2017-09-28T19:33:18.715-04:00",
"performer": [
{
"reference": "Organization/357",
"display": "PCP170967"
},
{
"reference": "Practitioner/358"
},
{
"reference": "Organization/357"
}
],
"result": [
{
"reference": "Observation/745",
"display": "Glucose"
},
{
"reference": "Observation/746",
"display": "Urea Nitrogen"
},
{
"reference": "Observation/747",
"display": "Creatinine"
},
{
"reference": "Observation/748",
"display": "Calcium"
},
{
"reference": "Observation/749",
"display": "Sodium"
},
{
"reference": "Observation/750",
"display": "Potassium"
},
{
"reference": "Observation/751",
"display": "Chloride"
},
{
"reference": "Observation/752",
"display": "Carbon Dioxide"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DiagnosticReport/814",
"resource": {
"resourceType": "DiagnosticReport",
"id": "814",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0074",
"code": "LAB",
"display": "Laboratory"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "51990-0",
"display": "Basic Metabolic Panel"
}
],
"text": "Basic Metabolic Panel"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/744"
},
"effectivePeriod": {
"start": "2017-09-28T19:33:18-04:00",
"end": "2017-09-28T20:33:18-04:00"
},
"issued": "2017-09-28T19:33:18.715-04:00",
"performer": [
{
"reference": "Organization/357",
"display": "PCP170967"
},
{
"reference": "Practitioner/358"
},
{
"reference": "Organization/357"
}
],
"result": [
{
"reference": "Observation/745",
"display": "Glucose"
},
{
"reference": "Observation/746",
"display": "Urea Nitrogen"
},
{
"reference": "Observation/747",
"display": "Creatinine"
},
{
"reference": "Observation/748",
"display": "Calcium"
},
{
"reference": "Observation/749",
"display": "Sodium"
},
{
"reference": "Observation/750",
"display": "Potassium"
},
{
"reference": "Observation/751",
"display": "Chloride"
},
{
"reference": "Observation/752",
"display": "Carbon Dioxide"
}
]
},
"search": {
"mode": "match"
}
}
]
}DocumentReference
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| masterIdentifier | Identifier | 0..1 | Master Version Specific Identifier |
| identifier | Identifier | 0..* | other identifiers for the document |
| status | code | 1..1 | current |
| docStatus | code | 0..1 | preliminary |
| type | CodeableConcept | 1..1 | kind of document - Binding |
| category | CodeableConcept | 1..* | categorization of document - Binding |
| subject | Reference(US Core Patient Profile) | 1..1 | who/what is the subject of the document |
| date | instant | 0..1 | when this document reference was created |
| author | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile |
| authenticator | Reference | 0..1 | who/what authenticated the document |
| custodian | Reference(US Core Organization Profile) | 0..1 | organization which maintains the document |
| relatesTo | BackboneElement | 0..* | relationships to other documents |
| description | string | 0..1 | human-readable description (title) |
| securityLabel | CodeableConcept | 0..* | document security-tags |
| content | BackboneElement | 1..* | document referenced |
| content.attachment | Attachment | 1..1 | where to access the document |
| content.attachment.contentType | code | 1..1 | mime type of the content, with charset etc. |
| context | BackboneElement | 0..* | clinical context of document |
Search Parameters
| Name | Type | Description |
|---|---|---|
| securitylabel | token | document security-tags |
| subject | reference | who/what is the subject of the document |
| description | string | human-readable description (title) |
| language | token | human language of the content (BCP-47) |
| type | token | kind of document (LOINC if possible) |
| relation | token | replaces |
| patient | reference | who/what is the subject of the document |
| event | token | main clinical acts documented |
| category | token | categorization of document |
| authenticator | reference | who/what authenticated the document |
| identifier | token | Master Version Specific Identifier |
| period | date | time of service that is being documented |
| custodian | reference | organization which maintains the document |
| author | reference | who and/or what authored the document |
| date | instant | when the document reference was created. |
| format | token | format/content rules for the document |
| encounter | reference | Context of the document content |
| location | uri | URI where the data can be found |
| relatesto | reference | target of the relationship |
| facility | token | kind of facility where patient was seen |
| status | token | current |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Profiles
The DocumentReference type field supports the full US Core DocumentReference Type value set including the following clinical note types and diagnostic report narratives:
- History and physical note (34117-2)
DocumentReference
Method: GET
{{BaseURL}}/DocumentReference
Examples
Using identifier
Request
GET {{BaseURL}}/DocumentReference/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:acc9d16d-da9b-9dc9-fbb4-9e6f950b11e6"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11506-3",
"display": "Progress note"
}
],
"text": "Progress note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1940-09-06T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDAtMDktMDYKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDUgbW9udGgtb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCk5vIEFjdGl2ZSBNZWRpY2F0aW9ucy4KCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/96"
}
],
"period": {
"start": "1940-09-06T01:11:45-04:00",
"end": "1940-09-06T01:26:45-04:00"
}
}
}Using search parameter
Request
GET {{BaseURL}}/DocumentReference?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "66ba2cda-637b-4763-88f7-29f30599a693",
"meta": {
"lastUpdated": "2022-11-04T16:03:19.593+00:00"
},
"type": "searchset",
"total": 20,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/DocumentReference?patient={{PPG}}"
},
{
"relation": "next",
"url": "{{BaseURL}}?_getpages=66ba2cda-637b-4763-88f7-29f30599a693&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/DocumentReference/{{ResourceId}}",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:acc9d16d-da9b-9dc9-fbb4-9e6f950b11e6"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11506-3",
"display": "Progress note"
}
],
"text": "Progress note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1940-09-06T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDAtMDktMDYKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDUgbW9udGgtb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCk5vIEFjdGl2ZSBNZWRpY2F0aW9ucy4KCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/96"
}
],
"period": {
"start": "1940-09-06T01:11:45-04:00",
"end": "1940-09-06T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DocumentReference/180",
"resource": {
"resourceType": "DocumentReference",
"id": "180",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:4fcadab6-9d33-a2f7-1657-9b1fdf79b7bf"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "57133-1",
"display": "Referral note"
}
],
"text": "Referral note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1951-09-04T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"custodian": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NTEtMDktMDQKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDExIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZS4KCiMgU29jaWFsIEhpc3RvcnkKIFBhdGllbnQgaGFzIG5ldmVyIHNtb2tlZCBhbmQgaXMgYW4gYWxjb2hvbGljLgoKUGF0aWVudCBjb21lcyBmcm9tIGEgaGlnaCBzb2Npb2Vjb25vbWljIGJhY2tncm91bmQuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgpQYXRpZW50IGlzIHByZXNlbnRpbmcgd2l0aCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4gCgojIyBQbGFuCgpUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gbWVkaWNhdGlvbiByZWNvbmNpbGlhdGlvbiAocHJvY2VkdXJlKQpUaGUgcGF0aWVudCB3YXMgcHJlc2NyaWJlZCB0aGUgZm9sbG93aW5nIG1lZGljYXRpb25zOgotIGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAo="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/175"
}
],
"period": {
"start": "1951-09-04T01:11:45-04:00",
"end": "1951-09-04T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DocumentReference/206",
"resource": {
"resourceType": "DocumentReference",
"id": "206",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:eb75e932-f3b5-1482-e142-0e31c97b4f95"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11488-4",
"display": "Consultation note"
}
],
"text": "Consultation note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1958-05-23T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NTgtMDUtMjMKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE4IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQ7IGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK"
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/202"
}
],
"period": {
"start": "1958-05-23T01:11:45-04:00",
"end": "1958-05-23T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DocumentReference/156",
"resource": {
"resourceType": "DocumentReference",
"id": "156",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:d7130c41-5c6c-b632-dd67-1ba7468f17c2"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History and physical note"
}
],
"text": "History and physical note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1947-03-21T00:11:45.131-05:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDctMDMtMjEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDYgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCmFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KUGF0aWVudCB3YXMgZ2l2ZW4gdGhlIGZvbGxvd2luZyBpbW11bml6YXRpb25zOiBpbmZsdWVuemEsIHNlYXNvbmFsLCBpbmplY3RhYmxlLCBwcmVzZXJ2YXRpdmUgZnJlZS4gCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/153"
}
],
"period": {
"start": "1947-03-21T00:11:45-05:00",
"end": "1947-03-21T00:26:45-05:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DocumentReference/256",
"resource": {
"resourceType": "DocumentReference",
"id": "256",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:15ad0f57-f7c3-2dec-0db4-feccdc3245d2"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11504-8",
"display": "Surgical operation note"
}
],
"text": "Surgical operation note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1971-06-11T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NzEtMDYtMTEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDMxIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDMyNSBtZyBvcmFsIHRhYmxldDsgYWNldGFtaW5vcGhlbiAyMS43IG1nL21sIC8gZGV4dHJvbWV0aG9ycGhhbiBoeWRyb2Jyb21pZGUgMSBtZy9tbCAvIGRveHlsYW1pbmUgc3VjY2luYXRlIDAuNDE3IG1nL21sIG9yYWwgc29sdXRpb247IHBlbmljaWxsaW4gZyAzNzUgbWcvbWwgaW5qZWN0YWJsZSBzb2x1dGlvbjsgYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldDsgYW1veGljaWxsaW4gMjUwIG1nIC8gY2xhdnVsYW5hdGUgMTI1IG1nIG9yYWwgdGFibGV0CgojIEFzc2Vzc21lbnQgYW5kIFBsYW4KCgojIyBQbGFuClBhdGllbnQgd2FzIGdpdmVuIHRoZSBmb2xsb3dpbmcgaW1tdW5pemF0aW9uczogaW5mbHVlbnphLCBzZWFzb25hbCwgaW5qZWN0YWJsZSwgcHJlc2VydmF0aXZlIGZyZWUuIApUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gbWVkaWNhdGlvbiByZWNvbmNpbGlhdGlvbiAocHJvY2VkdXJlKQo="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/252"
}
],
"period": {
"start": "1971-06-11T01:11:45-04:00",
"end": "1971-06-11T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DocumentReference/276",
"resource": {
"resourceType": "DocumentReference",
"id": "276",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:6f01c40c-3b4d-bb63-d997-950dc7f43ab9"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34746-8",
"display": "Nurse Note"
}
],
"text": "Nurse Note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1975-04-07T02:42:45.131-04:00",
"author": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"custodian": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NzUtMDQtMDcKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDM1IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDMyNSBtZyBvcmFsIHRhYmxldDsgYWNldGFtaW5vcGhlbiAyMS43IG1nL21sIC8gZGV4dHJvbWV0aG9ycGhhbiBoeWRyb2Jyb21pZGUgMSBtZy9tbCAvIGRveHlsYW1pbmUgc3VjY2luYXRlIDAuNDE3IG1nL21sIG9yYWwgc29sdXRpb247IHBlbmljaWxsaW4gZyAzNzUgbWcvbWwgaW5qZWN0YWJsZSBzb2x1dGlvbjsgYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldDsgZnVyb3NlbWlkZSA0MCBtZyBvcmFsIHRhYmxldDsgYW1veGljaWxsaW4gMjUwIG1nIC8gY2xhdnVsYW5hdGUgMTI1IG1nIG9yYWwgdGFibGV0CgojIEFzc2Vzc21lbnQgYW5kIFBsYW4KCgojIyBQbGFuCgpUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gb3h5Z2VuIGFkbWluaXN0cmF0aW9uIGJ5IG1hc2sgKHByb2NlZHVyZSkKLSBwbGFjaW5nIHN1YmplY3QgaW4gcHJvbmUgcG9zaXRpb24gKHByb2NlZHVyZSkKLSBwbGFpbiBjaGVzdCB4LXJheSAocHJvY2VkdXJlKQo="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/273"
}
],
"period": {
"start": "1975-04-07T02:42:45-04:00",
"end": "1975-04-07T03:42:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DocumentReference/218",
"resource": {
"resourceType": "DocumentReference",
"id": "218",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:3a79a6cf-302f-32b5-42f7-44f471c2cbbc"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History and physical note"
}
],
"text": "History and physical note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1959-05-29T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NTktMDUtMjkKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE5IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDIxLjcgbWcvbWwgLyBkZXh0cm9tZXRob3JwaGFuIGh5ZHJvYnJvbWlkZSAxIG1nL21sIC8gZG94eWxhbWluZSBzdWNjaW5hdGUgMC40MTcgbWcvbWwgb3JhbCBzb2x1dGlvbjsgcGVuaWNpbGxpbiBnIDM3NSBtZy9tbCBpbmplY3RhYmxlIHNvbHV0aW9uOyBhc3BpcmluIDgxIG1nIG9yYWwgdGFibGV0OyBhbW94aWNpbGxpbiAyNTAgbWcgLyBjbGF2dWxhbmF0ZSAxMjUgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KUGF0aWVudCB3YXMgZ2l2ZW4gdGhlIGZvbGxvd2luZyBpbW11bml6YXRpb25zOiBpbmZsdWVuemEsIHNlYXNvbmFsLCBpbmplY3RhYmxlLCBwcmVzZXJ2YXRpdmUgZnJlZS4gCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/214"
}
],
"period": {
"start": "1959-05-29T01:11:45-04:00",
"end": "1959-05-29T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DocumentReference/152",
"resource": {
"resourceType": "DocumentReference",
"id": "152",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:95f2314e-8bd2-bb55-dc66-6d733185d60e"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "18842-5",
"display": "Discharge summary"
}
],
"text": "Discharge summary"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1947-01-22T01:11:45.131-05:00",
"author": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"custodian": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDctMDEtMjIKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDYgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCmFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/150"
}
],
"period": {
"start": "1947-01-22T01:11:45-05:00",
"end": "1947-01-22T01:26:45-05:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DocumentReference/168",
"resource": {
"resourceType": "DocumentReference",
"id": "168",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:2536ace1-6f55-5495-bd52-3937e0f63a13"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11506-3",
"display": "Progress note"
}
],
"text": "Progress note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1949-04-01T00:11:45.131-05:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDktMDQtMDEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDkgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCnBlbmljaWxsaW4gZyAzNzUgbWcvbWwgaW5qZWN0YWJsZSBzb2x1dGlvbjsgYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAK"
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/165"
}
],
"period": {
"start": "1949-04-01T00:11:45-05:00",
"end": "1949-04-01T00:26:45-05:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/DocumentReference/198",
"resource": {
"resourceType": "DocumentReference",
"id": "198",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:393d97e4-f301-e7d8-9332-778dbc75e751"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34746-8",
"display": "Nurse Note"
}
],
"text": "Nurse Note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1956-05-11T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NTYtMDUtMTEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE2IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGhhcyBuZXZlciBzbW9rZWQgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGN1cnJlbnRseSBoYXMgQmx1ZSBDcm9zcyBCbHVlIFNoaWVsZC4KCiMgQWxsZXJnaWVzCk5vIEtub3duIEFsbGVyZ2llcy4KCiMgTWVkaWNhdGlvbnMKcGVuaWNpbGxpbiBnIDM3NSBtZy9tbCBpbmplY3RhYmxlIHNvbHV0aW9uOyBhc3BpcmluIDgxIG1nIG9yYWwgdGFibGV0OyBhbW94aWNpbGxpbiAyNTAgbWcgLyBjbGF2dWxhbmF0ZSAxMjUgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KUGF0aWVudCB3YXMgZ2l2ZW4gdGhlIGZvbGxvd2luZyBpbW11bml6YXRpb25zOiBpbmZsdWVuemEsIHNlYXNvbmFsLCBpbmplY3RhYmxlLCBwcmVzZXJ2YXRpdmUgZnJlZS4gClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/195"
}
],
"period": {
"start": "1956-05-11T01:11:45-04:00",
"end": "1956-05-11T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
}
]
}Encounter
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | identifier(s) by which this encounter is known |
| status | code | 1..1 | planned |
| statusHistory | BackboneElement | 0..* | list of past encounter statuses |
| class | Coding | 1..1 | inpatient |
| classHistory | BackboneElement | 0..* | list of past encounter classes |
| type | CodeableConcept | 1..* | specific type of encounter - Binding |
| serviceType | CodeableConcept | 0..1 | specific type of service |
| priority | CodeableConcept | 0..1 | indicates the urgency of the encounter |
| subject | Reference(US Core Patient Profile) | 1..1 | the patient or group present at the encounter |
| episodeOfCare | Reference | 0..* | episode(s) of care that this encounter should be recorded against |
| basedOn | Reference | 0..* | the ServiceRequest that initiated this encounter |
| participant | BackboneElement | 0..* | list of participants involved in the encounter |
| appointment | Reference | 0..* | the appointment that scheduled this encounter |
| period | Period | 0..1 | the start and end time of the encounter |
| length | Duration | 0..1 | quantity of time the encounter lasted (less time absent) |
| reasonCode | CodeableConcept | 0..* | coded reason the encounter takes place |
| reasonReference | Reference | 0..* | reason the encounter takes place (reference) |
| diagnosis | BackboneElement | 0..* | the list of diagnoses relevant to this encounter |
| account | Reference | 0..* | the set of accounts that may be used for billing for this Encounter |
| hospitalization | BackboneElement | 0..1 | details about the admission to a healthcare service |
| hospitalization.dischargeDisposition | CodeableConcept | 0..1 | category or kind of location after discharge |
| location | BackboneElement | 0..* | list of locations where the patient has been |
| location.location | Location | 1..1 | location the encounter takes place |
| serviceProvider | Reference | 0..1 | the custodian organization of this Encounter record |
| partOf | Reference | 0..1 | another encounter this encounter is part of |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | a date within the period the Encounter lasted |
| identifier | token | identifier(s) by which this encounter is known |
| episodeofcare | reference | episode(s) of care that this encounter should be recorded against |
| participant-type | token | role of participant in encounter |
| practitioner | reference | persons involved in the encounter other than the patient |
| subject | reference | the patient or group present at the encounter |
| length | number | length of encounter in days |
| diagnosis | reference | reason the encounter takes place (resource) |
| appointment | reference | the appointment that scheduled this encounter |
| participant | reference | persons involved in the encounter other than the patient |
| patient | reference | the patient or group present at the encounter |
| location-period | date | time period during which the patient was present at the location |
| location | reference | location the encounter takes place |
| service-provider | reference | the custodian organization of this encounter record |
| class | token | inpatient |
| status | token | planned |
| service-type | token | |
| _include | Encounter:episodeofcare | |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Encounter
Method: GET
{{BaseURL}}/Encounter
Examples
Using identifier
Request
GET {{BaseURL}}/Encounter/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Encounter",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
]
},
"identifier": [
{
"use": "official",
"system": "https://github.com/synthetichealth/synthea",
"value": "f3a71d9a-67bd-756f-2de7-db59e6788457"
}
],
"status": "finished",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "AMB"
},
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "162673000",
"display": "General examination of patient (procedure)"
}
],
"text": "General examination of patient (procedure)"
}
],
"subject": {
"reference": "Patient/{{PPG}}",
"display": "Mr. Lucien408 Bosco882"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
],
"text": "primary performer"
}
],
"period": {
"start": "1958-05-23T01:11:45-04:00",
"end": "1958-05-23T01:26:45-04:00"
},
"individual": {
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
}
],
"period": {
"start": "1958-05-23T01:11:45-04:00",
"end": "1958-05-23T01:26:45-04:00"
},
"location": [
{
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
}
],
"serviceProvider": {
"reference": "Organization/87",
"display": "PCP87052"
}
}Goal
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external Ids for this goal |
| lifecycleStatus | code | 1..1 | proposed |
| achievementStatus | code | 0..1 | in-progress |
| category | CodeableConcept | 0..* | e.g. Treatment, dietary, behavioral, etc. |
| priority | CodeableConcept | 0..1 | high-priority |
| description | CodeableConcept | 1..1 | code or text describing goal |
| subject | Reference(US Core Patient Profile) | 1..1 | who this goal is intended for |
| startDate | date | 0..1 | when goal pursuit begins |
| startCodeableConcept | CodeableConcept | 0..1 | when goal pursuit begins |
| target | BackboneElement | 0..* | target outcome for the goal |
| target.dueDate | date | 0..1 | reach goal on or before |
| statusDate | date | 0..1 | when goal status took effect |
| statusReason | string | 0..1 | reason for current status |
| expressedBy | Reference | 0..1 | who’s responsible for creating Goal |
| addresses | Reference | 0..* | issues addressed by this goal |
| note | Annotation | 0..* | comments about the goal |
| outcomeCode | CodeableConcept | 0..* | what result was achieved regarding the goal |
| outcomeReference | Reference | 0..* | observation that resulted from goal |
Search Parameters
| Name | Type | Description |
|---|---|---|
| patient | reference | who this goal is intended for |
| subject | reference | who this goal is intended for |
| start-date | date | when goal pursuit begins |
| category | token | e.g. treatment, dietary, behavioral, etc. |
| lifecycleStatus | token | proposed |
| achievementStatus | token | in-progress |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Goal
Method: GET
{{BaseURL}}/Goal
Examples
Using identifier
Request
GET {{BaseURL}}/Goal/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Goal",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
]
},
"lifecycleStatus": "active",
"description": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "281004",
"display": "Alcoholic dementia"
}
],
"text": "Alcoholic dementia"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"target": [
{
"dueDate": "2020-12-07"
}
]
}Using search parameter
Request
GET {{BaseURL}}/Goal?patient={{PPG}}&_revinclude=Provenance:target
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "07aa2339-685b-47d0-8053-10ea1c1f5460",
"meta": {
"lastUpdated": "2022-11-04T16:03:21.867+00:00"
},
"type": "searchset",
"total": 0,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/Goal?_revinclude=Provenance%3Atarget&patient={{PPG}}"
}
]
}Immunization
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | business identifier |
| status | code | 1..1 | completed |
| statusReason | boolean | 0..1 | reason not done - Binding |
| vaccineCode | CodeableConcept | 1..1 | vaccine product administered - Binding |
| patient | Reference(US Core Patient Profile) | 1..1 | who was immunized |
| encounter | Reference | 0..1 | encounter immunization was part of |
| occurrenceDateTime | dateTime | 1..1 | vaccination administration date - either occurenceDateTime or occurenceString must be set |
| occurrenceString | string | 1..1 | vaccination administration date - either occurenceDateTime or occurenceString must be set |
| recorded | dateTime | 0..1 | when the immunization was first captured in the subject’s record |
| primarySource | boolean | 1..1 | indicates context the data was recorded in |
| reportOrigin | CodeableConcept | 0..1 | indicates the source of a secondarily reported record |
| location | Reference | 0..1 | where vaccination occurred |
| manufacturer | Reference | 0..1 | vaccine manufacturer |
| lotNumber | string | 0..1 | vaccine lot number |
| expirationDate | date | 0..1 | vaccine expiration date |
| site | CodeableConcept | 0..1 | body site vaccine was administered |
| route | CodeableConcept | 0..1 | how vaccine entered body |
| doseQuantity | Quantity | 0..1 | amount of vaccine administered |
| performer | BackboneElement | 0..* | who performed event |
| note | Annotation | 0..* | additional immunization notes |
| reasonCode | CodeableConcept | 0..* | why immunization occurred |
| reasonReference | Reference | 0..* | why immunization occurred |
| isSubpotent | boolean | 0..1 | dose potency |
| subpotentReason | CodeableConcept | 0..* | reason for being subpotent |
| education | BackboneElement | 0..1 | educational material presented to patient + Rule: One of documentType or reference SHALL be present |
| programEligibility | CodeableConcept | 0..* | patient eligibility for a vaccination program |
| fundingSource | CodeableConcept | 0..* | funding source for the vaccine |
| reaction | BackboneElement | 0..* | details of a reaction that follows immunization |
| protocolApplied | BackboneElement | 0..* | protocol followed by the provider |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | vaccination (non)-Administration Date |
| identifier | token | business identifier |
| location | reference | the service delivery location or facility in which the vaccine was/was to be administered |
| lot-number | string | vaccine Lot Number |
| manufacturer | reference | vaccine Manufacturer |
| patient | reference | the patient for the vaccination record |
| performer | reference | the practitioner who played a role in the vaccination |
| reaction | reference | additional information on reaction |
| reaction-date | date | when reaction started |
| reason-code | token | reason why the vaccine was administered |
| reason-reference | reference | why immunization occurred |
| series | string | the series being followed by the provider |
| status | token | immunization event status |
| status-reason | token | reason why the vaccine was not administered |
| target-disease | token | the target disease the dose is being administered against |
| vaccine-code | token | vaccine product administered |
| _include | undefined | immunization:manufacturer |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Immunization
Method: GET
{{BaseURL}}/Immunization
Examples
Using identifier
Request
GET {{BaseURL}}/Immunization/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Immunization",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/169"
},
"occurrenceDateTime": "1950-04-07T00:11:45-05:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
}Using search parameter
Request
GET {{BaseURL}}/Immunization?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "199f12b2-1b90-4283-8ee5-1ac95d34ee9b",
"meta": {
"lastUpdated": "2022-11-04T16:03:21.977+00:00"
},
"type": "searchset",
"total": 20,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/Immunization?patient={{PPG}}"
},
{
"relation": "next",
"url": "{{BaseURL}}?_getpages=199f12b2-1b90-4283-8ee5-1ac95d34ee9b&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/Immunization/171",
"resource": {
"resourceType": "Immunization",
"id": "171",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/169"
},
"occurrenceDateTime": "1950-04-07T00:11:45-05:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Immunization/141",
"resource": {
"resourceType": "Immunization",
"id": "141",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/139"
},
"occurrenceDateTime": "1945-03-09T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Immunization/240",
"resource": {
"resourceType": "Immunization",
"id": "240",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/238"
},
"occurrenceDateTime": "1964-02-14T00:11:45-05:00",
"primarySource": true,
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Immunization/247",
"resource": {
"resourceType": "Immunization",
"id": "247",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/244"
},
"occurrenceDateTime": "1968-06-07T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Immunization/201",
"resource": {
"resourceType": "Immunization",
"id": "201",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/199"
},
"occurrenceDateTime": "1957-05-17T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Immunization/189",
"resource": {
"resourceType": "Immunization",
"id": "189",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/187"
},
"occurrenceDateTime": "1954-04-30T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Immunization/295",
"resource": {
"resourceType": "Immunization",
"id": "295",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/292"
},
"occurrenceDateTime": "1976-05-07T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Immunization/288",
"resource": {
"resourceType": "Immunization",
"id": "288",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/285"
},
"occurrenceDateTime": "1975-05-02T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Immunization/271",
"resource": {
"resourceType": "Immunization",
"id": "271",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/268"
},
"occurrenceDateTime": "1974-04-26T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Immunization/226",
"resource": {
"resourceType": "Immunization",
"id": "226",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/223"
},
"occurrenceDateTime": "1962-06-01T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
}
]
}MedicationRequest
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external ids for this request |
| status | code | 1..1 | active |
| statusReason | CodeableConcept | 0..1 | reason for current status |
| intent | code | 1..1 | proposal |
| category | CodeableConcept | 0..1 | type of medication usage |
| priority | code | 0..1 | routine |
| doNotPerform | boolean | 0..1 | true if request is prohibiting action |
| reportedBoolean | boolean | 0..1 | reported rather than primary record |
| reportedReference | reference | 0..1 | reported rather than primary record |
| medicationCodeableConcept | CodeableConcept | 1..1 | medication to be taken |
| subject | Reference(US Core Patient Profile) | 1..1 | who or group medication request is for |
| encounter | Reference | 0..1 | encounter created as part of encounter/admission/stay |
| supportingInformation | Reference | 0..* | information to support ordering of the medication |
| authoredOn | dateTime | 1..1 | when request was initially authored |
| requester | Reference(US Core Practitioner Profile | US Core Organization Profile | 1..1 |
| performer | Reference | 0..1 | intended performer of administration |
| performerType | CodeableConcept | 0..1 | desired kind of performer of the medication administration |
| recorder | Reference | 0..1 | person who entered the request |
| reasonCode | CodeableConcept | 0..* | reason or indication for ordering or not ordering the medication |
| reasonReference | Reference | 0..* | condition or observation that supports why the prescription is being written |
| instantiatesCanonical | canonical | 0..* | instantiates FHIR protocol or definition |
| instantiatesUri | uri | 0..* | instantiates external protocol or definition |
| basedOn | Reference | 0..* | what request fulfills |
| groupIdentifier | Identifier | 0..1 | composite request this is part of |
| courseOfTherapyType | CodeableConcept | 0..1 | overall pattern of medication administration |
| insurance | Reference | 0..* | associated insurance coverage |
| note | Annotation | 0..* | information about the prescription |
| dosageInstruction | Dosage | 0..* | how the medication should be taken |
| dosageInstruction.text | string | 0..1 | rree text dosage instructions e.g. SIG |
| dispenseRequest | BackboneElement | 0..1 | medication supply authorization |
| substitution | BackboneElement | 0..1 | any restrictions on medication substitution |
| priorPrescription | Reference | 0..1 | an order/prescription that is being replaced |
| detectedIssue | Reference | 0..* | clinical Issue with action |
| eventHistory | Reference | 0..* | a list of events of interest in the lifecycle |
Search Parameters
| Name | Type | Description |
|---|---|---|
| authoredon | date | Return prescriptions written on this date |
| date | date | returns medication request to be administered on a specific date |
| identifier | token | return prescriptions with this external identifier |
| intent | token | returns prescriptions with different intents |
| medication | reference | return prescriptions of this medication reference |
| patient | reference | returns prescriptions for a specific patient |
| status | token | status of the prescription |
| subject | reference | the identity of a patient to list orders for |
| _include | undefined | MedicationRequest:medication |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
MedicationRequest
Method: GET
{{BaseURL}}/MedicationRequest
Examples
Using identifier
Request
GET {{BaseURL}}/MedicationRequest/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "MedicationRequest",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"medicationReference": {
"reference": "Medication/281"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"authoredOn": "1975-04-07T02:51:45-04:00",
"requester": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
},
"reasonReference": [
{
"reference": "Condition/260"
}
]
}Using search parameters
Request
GET {{BaseURL}}/MedicationRequest?intent=order&patient={{PPG}}&status=active
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "e25ef91a-e70f-412e-af57-d1f9b761d03c",
"meta": {
"lastUpdated": "2022-11-04T16:03:23.675+00:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/MedicationRequest?intent=order&patient={{PPG}}&status=active"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/MedicationRequest/{{ResourceId}}",
"resource": {
"resourceType": "MedicationRequest",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"medicationReference": {
"reference": "Medication/281"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"authoredOn": "1975-04-07T02:51:45-04:00",
"requester": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
},
"reasonReference": [
{
"reference": "Condition/260"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/MedicationRequest/{{ResourceId}}",
"resource": {
"resourceType": "MedicationRequest",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "313988",
"display": "Furosemide 40 MG Oral Tablet"
}
],
"text": "Furosemide 40 MG Oral Tablet"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/308"
},
"authoredOn": "1977-05-13T01:11:45-04:00",
"requester": {
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
},
"reasonReference": [
{
"reference": "Condition/260"
}
],
"dosageInstruction": [
{
"sequence": 1,
"text": "Take as needed.",
"asNeededBoolean": true
}
]
},
"search": {
"mode": "match"
}
}
]
}Observation
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | business Identifier for observation |
| basedOn | Reference | 0..* | fulfills plan, proposal or order |
| partOf | Reference | 0..* | part of referenced event |
| status | code | 1..1 | registered |
| category | CodeableConcept | 1..* | classification of type of observation |
| code | CodeableConcept | 1..1 | type of observation (code / type) |
| subject | Reference | 1..1 | who and/or what this is about |
| focus | Reference | 0..* | what request fulfills |
| encounter | Reference | 0..1 | healthcare event during which this observation is made |
| effectiveDateTime | dateTime | 0..1 | clinically relevant time/time-period for observation |
| effectivePeriod | Period | 0..1 | clinically relevant time/time-period for observation |
| effectiveTiming | Timing | 0..1 | clinically relevant time/time-period for observation |
| effectiveInstant | instant | 0..1 | clinically relevant time/time-period for observation |
| issued | instant | 0..1 | date/time this was made available |
| performer | Reference | 0..* | who is responsible for the observation |
| valueQuantity | Quantity | 0..1 | actual result |
| valueCodeableConcept | CodeableConcept | 0..1 | actual result |
| valueString | string | 0..1 | actual result |
| valueBoolean | boolean | 0..1 | actual result |
| valueInteger | integer | 0..1 | actual result |
| valueRange | Range | 0..1 | actual result |
| valueRatio | Ratio | 0..1 | actual result |
| valueSampledData | SampledData | 0..1 | actual result |
| valueTime | time | 0..1 | actual result |
| valueDateTime | dateTime | 0..1 | actual result |
| valuePeriod | Period | 0..1 | actual result |
| dataAbsentReason | CodeableConcept | 0..1 | why the result is missing |
| interpretation | CodeableConcept | 0..* | high, low, normal, etc. |
| note | string | 0..1 | comments about the observation |
| bodySite | CodeableConcept | 0..1 | observed body part |
| method | CodeableConcept | 0..1 | how it was done |
| specimen | Reference | 0..1 | specimen used for this observation |
| device | Reference | 0..1 | (Measurement) Device |
| referenceRange | BackboneElement | 0..* | provides guide for interpretation |
| hasMember | Reference | 0..* | who is responsible for the observation |
| component | BackboneElement | 0..* | component results |
| dataAbsentReason | CodeableConcept | 0..1 |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | obtained date/time. If the obtained element is a period, a date that falls in the period |
| code | token | the code of the observation type |
| subject | reference | the subject that the observation is about |
| value-concept | token | the value of the observation, if the value is a CodeableConcept |
| value-date | date | the value of the observation, if the value is a date or period of time |
| patient | reference | the subject that the observation is about (if patient) |
| specimen | reference | specimen used for this observation |
| value-string | string | the value of the observation, if the value is a string, and also searches in CodeableConcept.text |
| performer | reference | who performed the observation |
| value-quantity | quantity | the value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| encounter | reference | encounter related to the observation |
| related-type | token | has-membertarge |
| related-target | reference | resource that is related to this one |
| category | token | the classification of the type of observation |
| status | token | the status of the observation |
| _include | Observation:subject | |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Profiles: -
- US Core Laboratory Result Observation Profile
- US Core Pediatric BMI for Age Observation Profile
- US Core Pediatric Head Occipital-frontal Circumference Percentile Profile
- US Core Pediatric Weight for Height Observation Profile
- US Core Pulse Oximetry Profile
- US Core Smoking Status Observation Profile
- Vital Signs Profile
- Supported Profiles: -
| Profile Name | Code | LOINC Name and Comments |
|---|---|---|
| Vital Signs Panel | 85353-1 | Vital signs, weight, height, head circumference, oxygen saturation and BMI panel |
| Respiratory Rate | 9279-1 | Respiratory Rate |
| Heart rate | 8867-4 | Heart rate |
| Oxygen saturation | 2708-6 | Oxygen saturation in Arterial blood |
| Body temperature | 8310-5 | Body temperature |
| Body height | 8302-2 | Body height |
| Head circumference | 9843-4 | Head Occipital-frontal circumference |
| Body weight | 29463-7 | Body weight |
| Body mass index | 39156-5 | Body mass index (BMI) |
| Blood pressure systolic and diastolic | 85354-9 | Blood pressure panel with all children optional |
| Systolic blood pressure | 8480-6 | Systolic blood pressure component |
| Diastolic blood pressure | 8462-4 | Diastolic blood pressure component |
Observation
Method: GET
{{BaseURL}}/Observation
Examples
Using identifier
Request
GET {{BaseURL}}/Observation/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/90"
},
"effectiveDateTime": "1940-03-29T00:11:45-05:00",
"issued": "1940-03-29T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
}Using search parameter
Request
GET {{BaseURL}}/Observation?code=72166&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "d1b8f87f-bbfc-49ad-ace3-621cb6ae947e",
"meta": {
"lastUpdated": "2022-11-04T16:03:24.705+00:00"
},
"type": "searchset",
"total": 38,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/Observation?code=72166-2&patient={{PPG}}"
},
{
"relation": "next",
"url": "{{BaseURL}}?_getpages=d1b8f87f-bbfc-49ad-ace3-621cb6ae947e&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/Observation/{{ResourceId}}",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/90"
},
"effectiveDateTime": "1940-03-29T00:11:45-05:00",
"issued": "1940-03-29T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/188",
"resource": {
"resourceType": "Observation",
"id": "188",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/187"
},
"effectiveDateTime": "1954-04-30T01:11:45-04:00",
"issued": "1954-04-30T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/117",
"resource": {
"resourceType": "Observation",
"id": "117",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/116"
},
"effectiveDateTime": "1941-06-06T01:11:45-04:00",
"issued": "1941-06-06T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/166",
"resource": {
"resourceType": "Observation",
"id": "166",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/165"
},
"effectiveDateTime": "1949-04-01T00:11:45-05:00",
"issued": "1949-04-01T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/200",
"resource": {
"resourceType": "Observation",
"id": "200",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/199"
},
"effectiveDateTime": "1957-05-17T01:11:45-04:00",
"issued": "1957-05-17T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/138",
"resource": {
"resourceType": "Observation",
"id": "138",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/137"
},
"effectiveDateTime": "1944-03-03T01:11:45-04:00",
"issued": "1944-03-03T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/177",
"resource": {
"resourceType": "Observation",
"id": "177",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/175"
},
"effectiveDateTime": "1951-09-07T01:11:45-04:00",
"issued": "1951-09-07T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/97",
"resource": {
"resourceType": "Observation",
"id": "97",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/96"
},
"effectiveDateTime": "1940-09-06T01:11:45-04:00",
"issued": "1940-09-06T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/196",
"resource": {
"resourceType": "Observation",
"id": "196",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/195"
},
"effectiveDateTime": "1956-05-11T01:11:45-04:00",
"issued": "1956-05-11T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/113",
"resource": {
"resourceType": "Observation",
"id": "113",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/112"
},
"effectiveDateTime": "1941-03-07T00:11:45-05:00",
"issued": "1941-03-07T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
}
]
}Using category=vital-signs
Request
GET {{BaseURL}}/Observation?category=vital-signs&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "2ce9d607-692c-4308-a464-1c277b3d8175",
"meta": {
"lastUpdated": "2022-11-04T16:04:02.429+00:00"
},
"type": "searchset",
"total": 26,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/Observation?category=vital-signs&patient={{PPG}}"
},
{
"relation": "next",
"url": "{{BaseURL}}?_getpages=2ce9d607-692c-4308-a464-1c277b3d8175&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/Observation/455",
"resource": {
"resourceType": "Observation",
"id": "455",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodyheight",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8302-2",
"display": "Body Height"
}
],
"text": "Body Height"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/454"
},
"effectiveDateTime": "1952-09-25T19:33:18-04:00",
"issued": "1952-09-25T19:33:18.715-04:00",
"valueQuantity": {
"value": 160,
"unit": "cm",
"system": "http://unitsofmeasure.org",
"code": "cm"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/808",
"resource": {
"resourceType": "Observation",
"id": "808",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bp",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "85354-9",
"display": "Blood Pressure"
}
],
"text": "Blood Pressure"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/619"
},
"effectivePeriod": {
"start": "1994-05-19T19:33:18-04:00",
"end": "1994-05-19T20:33:18-04:00"
},
"issued": "1994-05-19T19:33:18.715-04:00",
"component": [
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8462-4",
"display": "Diastolic Blood Pressure"
}
],
"text": "Diastolic Blood Pressure"
},
"valueQuantity": {
"value": 85,
"unit": "mm[Hg]",
"system": "http://unitsofmeasure.org",
"code": "mm[Hg]"
}
},
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8480-6",
"display": "Systolic Blood Pressure"
}
],
"text": "Systolic Blood Pressure"
},
"valueQuantity": {
"value": 129,
"unit": "mm[Hg]",
"system": "http://unitsofmeasure.org",
"code": "mm[Hg]"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/798",
"resource": {
"resourceType": "Observation",
"id": "798",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/vitalsigns",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8289-1",
"display": "Head Occipital-frontal circumference Percentile"
}
]
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"effectiveDateTime": "1940-10-05T00:00:00+00:00",
"dataAbsentReason": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "Unknown"
}
],
"text": "Unknown"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/803",
"resource": {
"resourceType": "Observation",
"id": "803",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodyweight",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "29463-7",
"display": "Body Weight"
}
],
"text": "Body Weight"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/583"
},
"effectiveDateTime": "1983-03-17T18:33:18-05:00",
"issued": "1983-03-17T18:33:18.715-05:00",
"dataAbsentReason": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "Unknown"
}
],
"text": "Unknown"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/813",
"resource": {
"resourceType": "Observation",
"id": "813",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodytemp",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8310-5",
"display": "Body temperature"
},
{
"system": "http://loinc.org",
"code": "8331-1",
"display": "Oral temperature"
}
],
"text": "Body temperature"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/707"
},
"effectivePeriod": {
"start": "2009-08-19T19:33:18-04:00",
"end": "2009-08-19T20:33:18-04:00"
},
"issued": "2009-08-19T19:33:18.715-04:00",
"valueQuantity": {
"value": 37.799,
"unit": "Cel",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/708",
"resource": {
"resourceType": "Observation",
"id": "708",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodytemp",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8310-5",
"display": "Body temperature"
},
{
"system": "http://loinc.org",
"code": "8331-1",
"display": "Oral temperature"
}
],
"text": "Body temperature"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/707"
},
"effectiveDateTime": "2009-08-19T19:33:18-04:00",
"issued": "2009-08-19T19:33:18.715-04:00",
"valueQuantity": {
"value": 37.799,
"unit": "Cel",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/801",
"resource": {
"resourceType": "Observation",
"id": "801",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodytemp",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8310-5",
"display": "Body temperature"
},
{
"system": "http://loinc.org",
"code": "8331-1",
"display": "Oral temperature"
}
],
"text": "Body temperature"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/707"
},
"effectiveDateTime": "2009-08-19T19:33:18-04:00",
"issued": "2009-08-19T19:33:18.715-04:00",
"dataAbsentReason": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "Unknown"
}
],
"text": "Unknown"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/420",
"resource": {
"resourceType": "Observation",
"id": "420",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "59576-9",
"display": "Body mass index (BMI) [Percentile] Per age and gender"
}
],
"text": "Body mass index (BMI) [Percentile] Per age and gender"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/419"
},
"effectiveDateTime": "1944-02-10T19:33:18-04:00",
"issued": "1944-02-10T19:33:18.715-04:00",
"valueQuantity": {
"value": 34.705,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/811",
"resource": {
"resourceType": "Observation",
"id": "811",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/vitalsigns",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8289-1",
"display": "Head Occipital-frontal circumference Percentile"
}
]
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"effectivePeriod": {
"start": "1940-10-05T00:00:00+00:00",
"end": "1940-10-05T01:00:00+00:00"
},
"valueQuantity": {
"value": 23,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Observation/806",
"resource": {
"resourceType": "Observation",
"id": "806",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/heartrate",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8867-4",
"display": "Heart rate"
}
],
"text": "Heart rate"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/665"
},
"effectivePeriod": {
"start": "2003-07-10T19:33:18-04:00",
"end": "2003-07-10T20:33:18-04:00"
},
"issued": "2003-07-10T19:33:18.715-04:00",
"valueQuantity": {
"value": 65,
"unit": "/min",
"system": "http://unitsofmeasure.org",
"code": "/min"
}
},
"search": {
"mode": "match"
}
}
]
}Organization
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | identifies this organization across multiple systems (see Profiles for details) |
| active | boolean | 1..1 | whether the organization’s record is still in active use |
| type | CodeableConcept | 0..* | kind of organization |
| name | string | 1..1 | name used for the organization |
| alias | string | 0..* | a list of alternate names that the organization is known as, or was known as in the past |
| telecom | ContactPoint | 0..* | a contact detail for the organization |
| address | Address | 0..* | an address for the organization |
| address.line | string | 0..* | street name, number, direction & P.O. Box etc. |
| address.city | string | 0..1 | name of city, town etc. |
| address.state | string | 0..1 | sub-unit of country (abbreviations ok) - Binding |
| address.postalCode | string | 0..1 | |
| address.country | string | 0..1 | country (e.g. can be ISO 3166 2 or 3 letter code) |
| partOf | Reference | 0..1 | the organization of which this organization forms a part |
| contact | BackboneElement | 0..* | contact for the organization for a certain purpose |
| endpoint | Reference | 0..* | technical endpoints providing access to services operated for the organization |
Search Parameters
| Name | Type | Description |
|---|---|---|
| identifier | token | any identifier for the organization (not the accreditation issuer’s identifier) |
| partof | reference | an organization of which this organization forms a part |
| address | string | a (part of the) address of the organization |
| address-state | string | a state specified in an address |
| active | token | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| type | token | a code for the type of organization |
| address-postalcode | string | a postal code specified in an address |
| name | string | a portion of the organization’s name or alias |
| address-city | string | a city specified in an address |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Organization
Method: GET
{{BaseURL}}/Organization
Examples
Using identifier
Request
GET {{BaseURL}}/Organization/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Organization",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
]
},
"identifier": [
{
"system": "https://github.com/synthetichealth/synthea",
"value": "56090ab7-1f97-37ff-a434-194f9c6e5510"
},
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "9999999999"
},
{
"system": "urn:oid:2.16.840.1.113883.4.7",
"value": "9999999999"
}
],
"active": true,
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/organization-type",
"code": "prov",
"display": "Healthcare Provider"
}
],
"text": "Healthcare Provider"
}
],
"name": "PCP87052",
"telecom": [
{
"system": "phone",
"value": "(555) 555-5555"
}
],
"address": [
{
"line": [
"1540 BRIDGE ST"
],
"city": "DRACUT",
"state": "MA",
"postalCode": "01826-2611",
"country": "US"
}
]
}Patient
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | an identifier for this patient |
| identifier.system | uri | 1..1 | the namespace for the identifier value |
| identifier.value | string | 1..1 | the value that is unique within the system. |
| active | boolean | 0..1 | whether this patient’s record is in active use |
| name | HumanName | 1..* | a name associated with the patient |
| name.use | code | 0..1 | usual |
| name.family | string | 0..1 | family name (often called ‘Surname’) |
| name.given | string | 0..* | given names (not always ‘first’). Includes middle names |
| name.prefix | string | 0..* | parts that come before the name |
| name.suffix | string | 0..* | parts that come after the name |
| name.period | Period | 0..* | time period when name was/is in use |
| telecom | ContactPoint | 0..* | a contact detail for the individual |
| telecom.system | code | 1..1 | phone |
| telecom.value | string | 1..1 | the actual contact point details |
| telecom.use | code | 0..1 | home |
| gender | code | 1..1 | male |
| birthDate | date | 0..1 | the date of birth for the individual |
| deceasedBoolean | boolean | 0..1 | indicates if the individual is deceased or not |
| deceasedDateTime | dateTime | 0..1 | indicates if the individual is deceased or not |
| address | Address | 0..* | addresses for the individual |
| address.line | string | 0..* | street name, number, direction & P.O. Box etc. |
| address.city | string | 0..1 | name of city, town etc. |
| address.state | string | 0..1 | sub-unit of country (abbreviations ok) - Binding |
| address.postalCode | string | 0..1 | |
| address.country | string | 0..1 | country (e.g. can be ISO 3166 2 or 3 letter code) |
| address.period | Period | 0..1 | time period when address was/is in use |
| maritalStatus | CodeableConcept | 0..1 | marital (civil) status of a patient |
| multipleBirthBoolean | boolean | 0..1 | whether patient is part of a multiple birth |
| multipleBirthInteger | integer | 0..1 | whether patient is part of a multiple birth |
| photo | Attachment | 0..* | image of the patient |
| contact | BackboneElement | 0..* | a contact party (e.g. guardian, partner, friend) for the patient |
| communication | BackboneElement | 0..* | a list of languages which may be used to communicate with the patient about his or her health |
| communication.language | CodeableConcept | 1..1 | the language which can be used to communicate with the patient about his or her health - Binding |
| generalPractitioner | Reference | 0..* | patient’s nominated primary care provider |
| managingOrganization | Reference | 0..1 | organization that is the custodian of the patient record |
| link | BackboneElement | 0..* | link to another patient resource that concerns the same actual person |
Search Parameters
| Name | Type | Description |
|---|---|---|
| _id | reference | patient id |
| active | token | whether the patient record is active |
| address | string | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| birthdate | date | the patient’s date of birth |
| death-date | date | the date of death has been provided and satisfies this search value |
| deceased | token | this patient has been marked as deceased, or as a death date entered |
| family | string | a portion of the family name of the patient |
| gender | token | gender of the patient |
| given | string | a portion of the given name of the patient |
| identifier | token | a patient identifier |
| language | token | language code (irrespective of use value) |
| link | reference | all patients linked to the given patient |
| name | string | a server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| telecom | token | the value in any kind of telecom details of the patient |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Patient
Method: GET
{{BaseURL}}/Patient
Examples
Using identifier
Request
GET {{BaseURL}}/Patient/{{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Patient",
"id": "{{PPG}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Generated by <a href=\"https://github.com/synthetichealth/synthea\">Synthea</a>.Version identifier: v2.6.1-3-g50f4f58f\n . Person seed: -7901283747506674198 Population seed: 3</div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White"
}
},
{
"url": "text",
"valueString": "White"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Non Hispanic or Latino"
}
]
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName",
"valueString": "Arnetta705 Walker122"
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "M"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace",
"valueAddress": {
"city": "Brookline",
"state": "Massachusetts",
"country": "US"
}
}
],
"identifier": [
{
"system": "https://github.com/synthetichealth/synthea",
"value": "d831ec91-c7a3-4a61-9312-7ff0c4a32134"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical Record Number"
}
],
"text": "Medical Record Number"
},
"system": "http://hospital.smarthealthit.org",
"value": "d831ec91-c7a3-4a61-9312-7ff0c4a32134"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SS",
"display": "Social Security Number"
}
],
"text": "Social Security Number"
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "999-47-5768"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "DL",
"display": "Driver's License"
}
],
"text": "Driver's License"
},
"system": "urn:oid:2.16.840.1.113883.4.3.25",
"value": "S99921496"
}
],
"name": [
{
"use": "official",
"family": "Bosco882",
"given": [
"Lucien408"
],
"prefix": [
"Mr."
]
}
],
"telecom": [
{
"system": "phone",
"value": "555-510-6254",
"use": "home"
}
],
"gender": "male",
"birthDate": "1940-03-29",
"deceasedDateTime": "1977-07-14T04:17:45-04:00",
"address": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/geolocation",
"extension": [
{
"url": "latitude",
"valueDecimal": 42.674176102041564
},
{
"url": "longitude",
"valueDecimal": -71.31980043648745
}
]
}
],
"line": [
"934 Olson Highlands"
],
"city": "Lowell",
"state": "MA",
"postalCode": "01854",
"country": "US",
"period": {
"start": "1940-03-29"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "M"
}
],
"text": "M"
},
"multipleBirthBoolean": false,
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en-US",
"display": "English"
}
],
"text": "English"
}
}
]
}Using patient name
Request
GET {{BaseURL}}/Patient?name=Bosco882
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "9d5b7bcb-c183-4b92-bcd8-b96b59a121e2",
"meta": {
"lastUpdated": "2022-11-04T16:03:14.259+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/Patient?name=Bosco882"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/Patient/{{PPG}}",
"resource": {
"resourceType": "Patient",
"id": "{{PPG}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Generated by <a href=\"https://github.com/synthetichealth/synthea\">Synthea</a>.Version identifier: v2.6.1-3-g50f4f58f\n . Person seed: -7901283747506674198 Population seed: 3</div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White"
}
},
{
"url": "text",
"valueString": "White"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Non Hispanic or Latino"
}
]
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName",
"valueString": "Arnetta705 Walker122"
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "M"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace",
"valueAddress": {
"city": "Brookline",
"state": "Massachusetts",
"country": "US"
}
}
],
"identifier": [
{
"system": "https://github.com/synthetichealth/synthea",
"value": "d831ec91-c7a3-4a61-9312-7ff0c4a32134"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical Record Number"
}
],
"text": "Medical Record Number"
},
"system": "http://hospital.smarthealthit.org",
"value": "d831ec91-c7a3-4a61-9312-7ff0c4a32134"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SS",
"display": "Social Security Number"
}
],
"text": "Social Security Number"
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "999-47-5768"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "DL",
"display": "Driver's License"
}
],
"text": "Driver's License"
},
"system": "urn:oid:2.16.840.1.113883.4.3.25",
"value": "S99921496"
}
],
"name": [
{
"use": "official",
"family": "Bosco882",
"given": [
"Lucien408"
],
"prefix": [
"Mr."
]
}
],
"telecom": [
{
"system": "phone",
"value": "555-510-6254",
"use": "home"
}
],
"gender": "male",
"birthDate": "1940-03-29",
"deceasedDateTime": "1977-07-14T04:17:45-04:00",
"address": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/geolocation",
"extension": [
{
"url": "latitude",
"valueDecimal": 42.674176102041564
},
{
"url": "longitude",
"valueDecimal": -71.31980043648745
}
]
}
],
"line": [
"934 Olson Highlands"
],
"city": "Lowell",
"state": "MA",
"postalCode": "01854",
"country": "US",
"period": {
"start": "1940-03-29"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "M"
}
],
"text": "M"
},
"multipleBirthBoolean": false,
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en-US",
"display": "English"
}
],
"text": "English"
}
}
]
},
"search": {
"mode": "match"
}
}
]
}Practitioner
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | an identifier for the person as this agent (see Profiles for details) |
| active | boolean | 0..1 | whether this practitioner’s record is in active use |
| name | HumanName | 1..* | the name(s) associated with the practitioner |
| name.family | string | 1..1 | family name (often called ‘Surname’) |
| telecom | ContactPoint | 0..* | a contact detail for the practitioner (that apply to all roles) |
| address | Address | 0..* | address(es) of the practitioner that are not role specific (typically home address) |
| gender | code | 0..1 | male |
| birthDate | date | 0..1 | the date on which the practitioner was born |
| photo | Attachment | 0..* | image of the person |
| qualification | BackboneElement | 0..* | qualifications obtained by training and certification |
| communication | CodeableConcept | 0..* | a language the practitioner is able to use in patient communication |
Search Parameters
| Name | Type | Description |
|---|---|---|
| identifier | token | a practitioner’s Identifier |
| given | string | a portion of the given name |
| address | string | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| address-state | string | a state specified in an address |
| gender | token | gender of the practitioner |
| active | token | whether the practitioner record is active |
| address-postalcode | string | a postalCode specified in an address |
| name | string | a server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| telecom | token | the value in any kind of contact |
| family | string | a portion of the family name |
| address-city | string | a city specified in an address |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Practitioner
Method: GET
{{BaseURL}}/Practitioner
Examples
Using identifier
Request
GET {{BaseURL}}/Practitioner/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Practitioner",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
]
},
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "9999958969"
}
],
"active": true,
"name": [
{
"family": "Torp761",
"given": [
"Melvin857"
],
"prefix": [
"Dr."
]
}
],
"telecom": [
{
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
"valueBoolean": true
}
],
"system": "email",
"value": "Melvin857.Torp761@example.com",
"use": "work"
}
],
"address": [
{
"line": [
"1540 BRIDGE ST"
],
"city": "DRACUT",
"state": "MA",
"postalCode": "01826-2611",
"country": "US"
}
],
"gender": "female"
}Procedure
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external Identifiers for this procedure |
| instantiatesCanonical | canonical | 0..* | instantiates FHIR protocol or definition |
| instantiatesUri | uri | 0..* | instantiates external protocol or definition |
| basedOn | Reference | 0..* | a request for this procedure |
| partOf | Reference | 0..* | part of referenced event |
| status | code | 1..1 | preparation |
| statusReason | CodeableConcept | 0..1 | reason for current status |
| category | CodeableConcept | 0..1 | classification of the procedure |
| code | CodeableConcept | 1..1 | identification of the procedure - Binding |
| subject | Reference(US Core Patient Profile) | 1..1 | who the procedure was performed on |
| encounter | Reference | 0..1 | encounter created as part of |
| recorder | Reference | 0..1 | who recorded the procedure |
| asserter | Reference | 0..1 | person who asserts this procedure |
| performedDateTime | dateTime | 1..1 | date/period the procedure was performed - either performedDateTime or performedPeriod must be set |
| performedPeriod | Period | 1..1 | date/period the procedure was performed - either performedDateTime or performedPeriod must be set |
| performer | BackboneElement | 0..* | the people who performed the procedure |
| location | Reference | 0..1 | where the procedure happened |
| reasonCode | CodeableConcept | 0..* | coded reason procedure performed |
| reasonReference | Reference | 0..* | condition that is the reason the procedure performed |
| bodySite | CodeableConcept | 0..* | target body sites |
| outcome | CodeableConcept | 0..1 | the result of procedure |
| report | Reference | 0..* | any report resulting from the procedure |
| complication | CodeableConcept | 0..* | complication following the procedure |
| complicationDetail | Reference | 0..* | a condition that is a result of the procedure |
| followUp | CodeableConcept | 0..* | instructions for follow up |
| note | Annotation | 0..* | additional information about the procedure |
| focalDevice | BackboneElement | 0..* | device changed in procedure |
| usedReference | Reference | 0..* | items used during procedure |
| usedCode | CodeableConcept | 0..* | coded items used during the procedure |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | date/period the procedure was performed |
| code | token | a code to identify a procedure |
| code_display | string | a code to identify a procedure |
| code:text | string | a code to identify a procedure |
| performer | reference | the reference to the practitioner |
| subject | reference | search by subject |
| encounter | reference | search by encounter |
| patient | reference | search by subject - a patient |
| context | reference | encounter or episode associated with the procedure |
| status | token | preparation |
| _include | undefined | Procedure:performer |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Procedure
Method: GET
{{BaseURL}}/Procedure
Examples
Using identifier
Request
GET {{BaseURL}}/Procedure/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Procedure",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "399208008",
"display": "Plain chest X-ray (procedure)"
}
],
"text": "Plain chest X-ray (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/273"
},
"performedPeriod": {
"start": "1975-04-07T02:42:45-04:00",
"end": "1975-04-07T03:12:45-04:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}Using search parameters
Request
GET {{BaseURL}}/Procedure?date=gt1975-04-06T02:42:45-04:00&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "bdf37cdc-00e1-447d-963d-3cbffd35fda9",
"meta": {
"lastUpdated": "2022-11-04T16:04:19.437+00:00"
},
"type": "searchset",
"total": 11,
"link": [
{
"relation": "self",
"url": "{{BaseURL}}/Procedure?date=gt1975-04-06T02%3A42%3A45-04%3A00&patient={{PPG}}"
},
{
"relation": "next",
"url": "{{BaseURL}}?_getpages=bdf37cdc-00e1-447d-963d-3cbffd35fda9&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "{{BaseURL}}/Procedure/{{ResourceId}}",
"resource": {
"resourceType": "Procedure",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "399208008",
"display": "Plain chest X-ray (procedure)"
}
],
"text": "Plain chest X-ray (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/273"
},
"performedPeriod": {
"start": "1975-04-07T02:42:45-04:00",
"end": "1975-04-07T03:12:45-04:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Procedure/279",
"resource": {
"resourceType": "Procedure",
"id": "279",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371908008",
"display": "Oxygen administration by mask (procedure)"
}
],
"text": "Oxygen administration by mask (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"performedPeriod": {
"start": "1975-04-07T02:51:45-04:00",
"end": "1975-04-07T03:06:45-04:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Procedure/299",
"resource": {
"resourceType": "Procedure",
"id": "299",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371908008",
"display": "Oxygen administration by mask (procedure)"
}
],
"text": "Oxygen administration by mask (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/298"
},
"performedPeriod": {
"start": "1977-03-28T02:25:45-05:00",
"end": "1977-03-28T02:40:45-05:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Procedure/305",
"resource": {
"resourceType": "Procedure",
"id": "305",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "431182000",
"display": "Placing subject in prone position (procedure)"
}
],
"text": "Placing subject in prone position (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/301"
},
"performedPeriod": {
"start": "1977-03-29T02:33:45-05:00",
"end": "1977-03-29T02:48:45-05:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Procedure/297",
"resource": {
"resourceType": "Procedure",
"id": "297",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "40701008",
"display": "Echocardiography (procedure)"
}
],
"text": "Echocardiography (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/296"
},
"performedPeriod": {
"start": "1976-09-29T03:25:45-04:00",
"end": "1976-09-29T03:55:45-04:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Procedure/303",
"resource": {
"resourceType": "Procedure",
"id": "303",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371908008",
"display": "Oxygen administration by mask (procedure)"
}
],
"text": "Oxygen administration by mask (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/301"
},
"performedPeriod": {
"start": "1977-03-28T02:33:45-05:00",
"end": "1977-03-28T02:48:45-05:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Procedure/300",
"resource": {
"resourceType": "Procedure",
"id": "300",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "431182000",
"display": "Placing subject in prone position (procedure)"
}
],
"text": "Placing subject in prone position (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/298"
},
"performedPeriod": {
"start": "1977-03-28T02:25:45-05:00",
"end": "1977-03-28T02:40:45-05:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Procedure/280",
"resource": {
"resourceType": "Procedure",
"id": "280",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "423475008",
"display": "Heart failure education (procedure)"
}
],
"text": "Heart failure education (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"performedPeriod": {
"start": "1975-04-08T02:51:45-04:00",
"end": "1975-04-08T03:25:45-04:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
},
"reasonReference": [
{
"reference": "Condition/260",
"display": "Chronic congestive heart failure (disorder)"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Procedure/291",
"resource": {
"resourceType": "Procedure",
"id": "291",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "430193006",
"display": "Medication Reconciliation (procedure)"
}
],
"text": "Medication Reconciliation (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/290"
},
"performedPeriod": {
"start": "1976-04-02T02:25:45-05:00",
"end": "1976-04-02T02:40:45-05:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "{{BaseURL}}/Procedure/304",
"resource": {
"resourceType": "Procedure",
"id": "304",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371908008",
"display": "Oxygen administration by mask (procedure)"
}
],
"text": "Oxygen administration by mask (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/301"
},
"performedPeriod": {
"start": "1977-03-29T02:33:45-05:00",
"end": "1977-03-29T02:48:45-05:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
}
]
}Provenance
Resource Content
| Name | Type | Cardinality | Required | Description |
|---|---|---|---|---|
| target | Reference | 1..* | * | target Reference(s) (usually version specific) |
| occuredPeriod | Period | 0..1 | when the activity occurred | |
| occuredDateTime | date | 0..1 | when the activity occurred | |
| recorded | instant | 1..1 | * | when the activity was recorded / updated |
| policy | uri | 0..* | policy or plan the activity was defined by | |
| location | Reference | 0..1 | where the activity occurred, if relevant | |
| reason | CodeableConcept | 0..* | reason the activity is occurring | |
| activity | CodeableConcept | 0..1 | activity that occurred | |
| agent | BackboneElement | 1..* | * | actor involved |
| agent.type | CodeableConcept | 0..* | how the agent participated - Binding (see Profiles for details) | |
| agent.who | Reference(US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | 1..1 |
| agent.onBehalfOf | Reference(US Core Organization Profile) | 0..1 | who the agent is representing (see Profiles for details) | |
| entity | BackboneElement | 0..* | an entity used in this activity | |
| signature | Signature | 0..* | indicates if the individual is deceased or not |
Provenance
Method: GET
{{BaseURL}}/Provenance
Examples
Using Identifier
Request
GET {{BaseURL}}/Provenance/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Provenance",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
]
},
"target": [
{
"reference": "Patient/{{PPG}}"
},
{
"reference": "Location/86"
},
{
"reference": "Organization/87"
},
{
"reference": "Practitioner/88"
},
{
"reference": "PractitionerRole/89"
},
{
"reference": "Encounter/90"
},
{
"reference": "Observation/91"
},
{
"reference": "Encounter/92"
},
{
"reference": "Observation/93"
},
{
"reference": "Encounter/94"
},
{
"reference": "Observation/95"
},
{
"reference": "Encounter/96"
},
{
"reference": "Observation/97"
},
{
"reference": "Procedure/98"
},
{
"reference": "DiagnosticReport/99"
},
{
"reference": "DocumentReference/100"
},
{
"reference": "Encounter/101"
},
{
"reference": "Observation/102"
},
{
"reference": "Location/103"
},
{
"reference": "Organization/104"
},
{
"reference": "Practitioner/105"
},
{
"reference": "PractitionerRole/106"
},
{
"reference": "Encounter/107"
},
{
"reference": "Condition/108"
},
{
"reference": "MedicationRequest/109"
},
{
"reference": "Encounter/110"
},
{
"reference": "Condition/111"
},
{
"reference": "Encounter/112"
},
{
"reference": "Observation/113"
},
{
"reference": "DiagnosticReport/114"
},
{
"reference": "DocumentReference/115"
},
{
"reference": "Encounter/116"
},
{
"reference": "Observation/117"
},
{
"reference": "DiagnosticReport/118"
},
{
"reference": "DocumentReference/119"
},
{
"reference": "Encounter/120"
},
{
"reference": "Observation/121"
},
{
"reference": "Procedure/122"
},
{
"reference": "DiagnosticReport/123"
},
{
"reference": "DocumentReference/124"
},
{
"reference": "Encounter/125"
},
{
"reference": "Observation/126"
},
{
"reference": "Procedure/127"
},
{
"reference": "DiagnosticReport/128"
},
{
"reference": "DocumentReference/129"
},
{
"reference": "Encounter/130"
},
{
"reference": "Observation/131"
},
{
"reference": "Encounter/132"
},
{
"reference": "Observation/133"
},
{
"reference": "Procedure/134"
},
{
"reference": "Encounter/135"
},
{
"reference": "Observation/136"
},
{
"reference": "Encounter/137"
},
{
"reference": "Observation/138"
},
{
"reference": "Encounter/139"
},
{
"reference": "Observation/140"
},
{
"reference": "Immunization/141"
},
{
"reference": "Encounter/142"
},
{
"reference": "Observation/143"
},
{
"reference": "Immunization/144"
},
{
"reference": "Encounter/145"
},
{
"reference": "Condition/146"
},
{
"reference": "MedicationRequest/147"
},
{
"reference": "CareTeam/148"
},
{
"reference": "CarePlan/149"
},
{
"reference": "Encounter/150"
},
{
"reference": "DiagnosticReport/151"
},
{
"reference": "DocumentReference/152"
},
{
"reference": "Encounter/153"
},
{
"reference": "Observation/154"
},
{
"reference": "DiagnosticReport/155"
},
{
"reference": "DocumentReference/156"
},
{
"reference": "Encounter/157"
},
{
"reference": "Condition/158"
},
{
"reference": "MedicationRequest/159"
},
{
"reference": "MedicationRequest/160"
},
{
"reference": "DiagnosticReport/161"
},
{
"reference": "DocumentReference/162"
},
{
"reference": "Encounter/163"
},
{
"reference": "Observation/164"
},
{
"reference": "Encounter/165"
},
{
"reference": "Observation/166"
},
{
"reference": "DiagnosticReport/167"
},
{
"reference": "DocumentReference/168"
},
{
"reference": "Encounter/169"
},
{
"reference": "Observation/170"
},
{
"reference": "Immunization/171"
},
{
"reference": "Encounter/172"
},
{
"reference": "Observation/173"
},
{
"reference": "Immunization/174"
},
{
"reference": "Encounter/175"
},
{
"reference": "Condition/176"
},
{
"reference": "Observation/177"
},
{
"reference": "MedicationRequest/178"
},
{
"reference": "DiagnosticReport/179"
},
{
"reference": "DocumentReference/180"
},
{
"reference": "Encounter/181"
},
{
"reference": "Observation/182"
},
{
"reference": "Immunization/183"
},
{
"reference": "Encounter/184"
},
{
"reference": "Observation/185"
},
{
"reference": "Immunization/186"
},
{
"reference": "Encounter/187"
},
{
"reference": "Observation/188"
},
{
"reference": "Immunization/189"
},
{
"reference": "DiagnosticReport/190"
},
{
"reference": "DocumentReference/191"
},
{
"reference": "Encounter/192"
},
{
"reference": "Observation/193"
},
{
"reference": "Immunization/194"
},
{
"reference": "Encounter/195"
},
{
"reference": "Observation/196"
},
{
"reference": "DiagnosticReport/197"
},
{
"reference": "DocumentReference/198"
},
{
"reference": "Encounter/199"
},
{
"reference": "Observation/200"
},
{
"reference": "Immunization/201"
},
{
"reference": "Encounter/202"
},
{
"reference": "Observation/203"
},
{
"reference": "Immunization/204"
},
{
"reference": "DiagnosticReport/205"
},
{
"reference": "DocumentReference/206"
},
{
"reference": "Encounter/207"
},
{
"reference": "Condition/208"
},
{
"reference": "MedicationRequest/209"
},
{
"reference": "CareTeam/210"
},
{
"reference": "CarePlan/211"
},
{
"reference": "DiagnosticReport/212"
},
{
"reference": "DocumentReference/213"
},
{
"reference": "Encounter/214"
},
{
"reference": "Observation/215"
},
{
"reference": "Immunization/216"
},
{
"reference": "DiagnosticReport/217"
},
{
"reference": "DocumentReference/218"
},
{
"reference": "Encounter/219"
},
{
"reference": "Condition/220"
},
{
"reference": "DiagnosticReport/221"
},
{
"reference": "DocumentReference/222"
},
{
"reference": "Encounter/223"
},
{
"reference": "Observation/224"
},
{
"reference": "Procedure/225"
},
{
"reference": "Immunization/226"
},
{
"reference": "DiagnosticReport/227"
},
{
"reference": "DocumentReference/228"
},
{
"reference": "Encounter/229"
},
{
"reference": "Condition/230"
},
{
"reference": "Encounter/231"
},
{
"reference": "Condition/232"
},
{
"reference": "MedicationRequest/233"
},
{
"reference": "CareTeam/234"
},
{
"reference": "CarePlan/235"
},
{
"reference": "DiagnosticReport/236"
},
{
"reference": "DocumentReference/237"
},
{
"reference": "Encounter/238"
},
{
"reference": "Observation/239"
},
{
"reference": "Immunization/240"
},
{
"reference": "Encounter/241"
},
{
"reference": "Observation/242"
},
{
"reference": "Immunization/243"
},
{
"reference": "Encounter/244"
},
{
"reference": "Observation/245"
},
{
"reference": "Procedure/246"
},
{
"reference": "Immunization/247"
},
{
"reference": "Encounter/248"
},
{
"reference": "Condition/249"
},
{
"reference": "Encounter/250"
},
{
"reference": "Condition/251"
},
{
"reference": "Encounter/252"
},
{
"reference": "Observation/253"
},
{
"reference": "Immunization/254"
},
{
"reference": "DiagnosticReport/255"
},
{
"reference": "DocumentReference/256"
},
{
"reference": "Encounter/257"
},
{
"reference": "Condition/258"
},
{
"reference": "Encounter/259"
},
{
"reference": "Condition/260"
},
{
"reference": "Procedure/261"
},
{
"reference": "Procedure/262"
},
{
"reference": "Encounter/263"
},
{
"reference": "Procedure/264"
},
{
"reference": "MedicationRequest/265"
},
{
"reference": "CareTeam/266"
},
{
"reference": "CarePlan/267"
},
{
"reference": "Encounter/268"
},
{
"reference": "Observation/269"
},
{
"reference": "MedicationRequest/270"
},
{
"reference": "Immunization/271"
},
{
"reference": "Encounter/272"
},
{
"reference": "Encounter/273"
},
{
"reference": "Procedure/274"
},
{
"reference": "DiagnosticReport/275"
},
{
"reference": "DocumentReference/276"
},
{
"reference": "Encounter/277"
},
{
"reference": "Observation/278"
},
{
"reference": "Procedure/279"
},
{
"reference": "Procedure/280"
},
{
"reference": "Medication/281"
},
{
"reference": "MedicationRequest/282"
},
{
"reference": "CareTeam/283"
},
{
"reference": "CarePlan/284"
},
{
"reference": "Encounter/285"
},
{
"reference": "Observation/286"
},
{
"reference": "MedicationRequest/287"
},
{
"reference": "Immunization/288"
},
{
"reference": "Encounter/289"
},
{
"reference": "Encounter/290"
},
{
"reference": "Procedure/291"
},
{
"reference": "Encounter/292"
},
{
"reference": "Observation/293"
},
{
"reference": "MedicationRequest/294"
},
{
"reference": "Immunization/295"
},
{
"reference": "Encounter/296"
},
{
"reference": "Procedure/297"
},
{
"reference": "Encounter/298"
},
{
"reference": "Procedure/299"
},
{
"reference": "Procedure/300"
},
{
"reference": "Encounter/301"
},
{
"reference": "Procedure/302"
},
{
"reference": "Procedure/303"
},
{
"reference": "Procedure/304"
},
{
"reference": "Procedure/305"
},
{
"reference": "CareTeam/306"
},
{
"reference": "CarePlan/307"
},
{
"reference": "Encounter/308"
},
{
"reference": "Observation/309"
},
{
"reference": "MedicationRequest/310"
},
{
"reference": "Immunization/311"
},
{
"reference": "Observation/315"
}
],
"recorded": "1977-07-15T01:11:45.131-04:00",
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author",
"display": "Author"
}
],
"text": "Author"
},
"who": {
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
},
"onBehalfOf": {
"reference": "Organization/87",
"display": "PCP87052"
}
},
{
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
"code": "transmitter",
"display": "Transmitter"
}
],
"text": "Transmitter"
},
"who": {
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
},
"onBehalfOf": {
"reference": "Organization/87",
"display": "PCP87052"
}
}
]
}Bulk-Data Access for System Apps
System applications need to generate an access token using the 2-legged O-auth workflow. Please refer to the Authorization and Authentication section for detailed instructions on the workflow.
Bulk Export Request - All Patients
The all-patients endpoint can be used to request bulk data exports for all patients in the practice represented in the base URL.
Method: GET
{{BaseURL}}/Patient/$export
Headers
| Content-Type | Value | Type |
|---|---|---|
| Accept | application/fhir+json | text |
Examples
Bulk Export Request
Request
GET {{BaseURL}}/Patient/$export
Response
202 - Accepted
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-location | {{BaseURL}}/Export/{{BulkExportGuid}} | text | |
| Accept | application/json | text | |
| Content-Type | application/json | text |
No response body
Bulk Export Request - Group of Patients
The group-of-patients endpoint can be used to request bulk data exports for a subset of patients in the practice represented by the base URL. The practice will first need to define a group of patients in the EHR and provide the associated group ID value – step-by-step instructions are available at https://help.practicefusion.com/s/article/what-is-a-fhir-group-and-how-do-i-create-one. Groups are limited to a maximum of 1,000 patients each.
Method: GET
{{BaseURL}}/Group/{{GroupId}}/$export
Headers
| Content-Type | Value | Type |
|---|---|---|
| Accept | application/fhir+json | text |
Examples
Bulk Export Request
Request
GET {{BaseURL}}/Group/{{GroupId}}/$export
Response
202 - Accepted
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-location | {{BaseURL}}/Export/{{BulkExportGuid}} | text | |
| Accept | application/json | text | |
| Content-Type | application/json | text |
No response body
Bulk Export Status check
Method: GET
{{BaseURL}}/Export/{{BulkExportGuid}}
Examples
Complete
Request
GET {{BaseURL}}/Export/{{BulkExportGuid}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"transactionTime": "2022-11-05T21:34:37.864+00:00",
"request": "{{BaseURL}}/Group/{{GroupId}}/$export",
"requiresAccessToken": true,
"output": [
{
"type": "Condition",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/condition/18677"
},
{
"type": "Immunization",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/immunization/18673"
},
{
"type": "MedicationRequest",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/medicationrequest/18678"
},
{
"type": "Provenance",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/provenance/18675"
},
{
"type": "Organization",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/organization/18689"
},
{
"type": "CareTeam",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/careteam/18680"
},
{
"type": "Device",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/device/18683"
},
{
"type": "Patient",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/patient/18682"
},
{
"type": "DiagnosticReport",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/diagnosticreport/18686"
},
{
"type": "Practitioner",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/practitioner/18685"
},
{
"type": "AllergyIntolerance",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/allergyintolerance/18687"
},
{
"type": "CarePlan",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/careplan/18674"
},
{
"type": "Goal",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/goal/18671"
},
{
"type": "Observation",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/observation/18684"
},
{
"type": "Procedure",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/procedure/18681"
},
{
"type": "Encounter",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/encounter/18679"
},
{
"type": "DocumentReference",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/documentreference/18676"
},
{
"type": "Location",
"url": "{{BaseURL}}/Binary/export/{{BulkExportGuid}}/location/18672"
}
],
"error": []
}In Progress
Request
GET {{BaseURL}}/Export/{{BulkExportGuid}}
Response
202 - Accepted
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
No response body
Delete Request
Request
DELETE {{BaseURL}}/Export/{{BulkExportGuid}}
Response
202 - Accepted
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
No response body
Retrieve Output (FHIR resource)
Request
GET {{BaseURL}}/Binary/Export/{{BulkExportGuid}}/CarePlan//18674
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "CarePlan",
"id": "384",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Self-care interventions (procedure).<br/>Activities: <ul><li>Self-care interventions (procedure)</li><li>Self-care interventions (procedure)</li><li>Self-care interventions (procedure)</li></ul></div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "384758001",
"display": "Self-care interventions (procedure)"
}
],
"text": "Self-care interventions (procedure)"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/382"
},
"period": {
"start": "1941-10-02T18:33:18-05:00"
},
"careTeam": [
{
"reference": "CareTeam/383"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "409002",
"display": "Food allergy diet"
}
],
"text": "Food allergy diet"
},
"status": "in-progress",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "58332002",
"display": "Allergy education"
}
],
"text": "Allergy education"
},
"status": "in-progress",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "58332002",
"display": "Allergy education"
}
],
"text": "Allergy education"
},
"status": "in-progress",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "773",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Demential management.<br/>Activities: <ul><li>Demential management</li><li>Demential management</li><li>Demential management</li></ul><br/>Care plan is meant to treat Alzheimer's disease (disorder).</div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386257007",
"display": "Demential management"
}
],
"text": "Demential management"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/768"
},
"period": {
"start": "2019-10-10T19:33:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/772"
}
],
"addresses": [
{
"reference": "Condition/769"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "0261000000100",
"display": "Education about dementia"
}
],
"text": "Education about dementia"
},
"status": "in-progress",
"location": {
"reference": "Location/356",
"display": "PCP170967"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "710125008",
"display": "Promotion of use of memory skills"
}
],
"text": "Promotion of use of memory skills"
},
"status": "in-progress",
"location": {
"reference": "Location/356",
"display": "PCP170967"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "315043002",
"display": "Long term social support"
}
],
"text": "Long term social support"
},
"status": "in-progress",
"location": {
"reference": "Location/356",
"display": "PCP170967"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "778",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/774"
},
"period": {
"start": "2020-03-04T18:54:18-05:00",
"end": "2020-03-19T19:33:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/777"
}
],
"addresses": [
{
"reference": "Condition/398"
},
{
"reference": "Condition/408"
},
{
"reference": "Condition/436"
},
{
"reference": "Condition/460"
},
{
"reference": "Condition/506"
},
{
"reference": "Condition/775"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "267",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Heart failure self management plan.<br/>Activities: <ul><li>Heart failure self management plan</li><li>Heart failure self management plan</li></ul><br/>Care plan is meant to treat Chronic congestive heart failure (disorder).</div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "735984001",
"display": "Heart failure self management plan"
}
],
"text": "Heart failure self management plan"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/263"
},
"period": {
"start": "1974-04-12T02:42:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/266"
}
],
"addresses": [
{
"reference": "Condition/260"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183063000",
"display": "low salt diet education"
}
],
"text": "low salt diet education"
},
"status": "in-progress",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183301007",
"display": "physical exercise"
}
],
"text": "physical exercise"
},
"status": "in-progress",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "463",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/459"
},
"period": {
"start": "1953-02-28T18:53:18-05:00",
"end": "1953-10-01T18:33:18-05:00"
},
"careTeam": [
{
"reference": "CareTeam/462"
}
],
"addresses": [
{
"reference": "Condition/398"
},
{
"reference": "Condition/408"
},
{
"reference": "Condition/436"
},
{
"reference": "Condition/460"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "400",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/397"
},
"period": {
"start": "1941-12-31T18:49:18-05:00",
"end": "1942-02-12T19:33:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/399"
}
],
"addresses": [
{
"reference": "Condition/398"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "786",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/783"
},
"period": {
"start": "2020-07-18T19:33:18-04:00",
"end": "2020-08-13T19:33:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/7"
}
],
"addresses": [
{
"reference": "Condition/398"
},
{
"reference": "Condition/408"
},
{
"reference": "Condition/436"
},
{
"reference": "Condition/460"
},
{
"reference": "Condition/506"
},
{
"reference": "Condition/775"
},
{
"reference": "Condition/784"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "211",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/207"
},
"period": {
"start": "1958-12-21T00:11:45-05:00",
"end": "1959-05-29T01:11:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/210"
}
],
"addresses": [
{
"reference": "Condition/208"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "531",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Wound care.<br/>Activities: <ul><li>Wound care</li><li>Wound care</li></ul><br/>Care plan is meant to treat Laceration of thigh.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "225358003",
"display": "Wound care"
}
],
"text": "Wound care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/526"
},
"period": {
"start": "1970-01-20T19:13:18-05:00",
"end": "1970-02-10T19:55:18-05:00"
},
"careTeam": [
{
"reference": "CareTeam/530"
}
],
"addresses": [
{
"reference": "Condition/527"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "3949008",
"display": "Dressing change management"
}
],
"text": "Dressing change management"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "439830001",
"display": "Behavior to prevent infection"
}
],
"text": "Behavior to prevent infection"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "149",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Fracture care.<br/>Activities: <ul><li>Fracture care</li><li>Fracture care</li></ul><br/>Care plan is meant to treat Fracture of clavicle.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "3691007",
"display": "Fracture care"
}
],
"text": "Fracture care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/145"
},
"period": {
"start": "1946-11-23T01:11:45-05:00",
"end": "1947-01-22T01:11:45-05:00"
},
"careTeam": [
{
"reference": "CareTeam/148"
}
],
"addresses": [
{
"reference": "Condition/146"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183051005",
"display": "Recommendation to rest"
}
],
"text": "Recommendation to rest"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "4080007",
"display": "Physical activity target light exercise"
}
],
"text": "Physical activity target light exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "410",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/407"
},
"period": {
"start": "1942-03-15T19:49:18-04:00",
"end": "1942-08-13T19:33:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/409"
}
],
"addresses": [
{
"reference": "Condition/398"
},
{
"reference": "Condition/408"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "475",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Physical therapy procedure.<br/>Activities: <ul><li>Physical therapy procedure</li><li>Physical therapy procedure</li></ul><br/>Care plan is meant to treat Sprain of ankle.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "91251008",
"display": "Physical therapy procedure"
}
],
"text": "Physical therapy procedure"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/472"
},
"period": {
"start": "1955-02-19T18:33:18-05:00",
"end": "1955-03-19T18:33:18-05:00"
},
"careTeam": [
{
"reference": "CareTeam/474"
}
],
"addresses": [
{
"reference": "Condition/473"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "229586001",
"display": "Rest, ice, compression and elevation treatment programme"
}
],
"text": "Rest, ice, compression and elevation treatment programme"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "229070002",
"display": "Stretching exercises"
}
],
"text": "Stretching exercises"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "284",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Inpatient care plan (record artifact).<br/>Activities: <ul><li>Inpatient care plan (record artifact)</li><li>Inpatient care plan (record artifact)</li></ul><br/>Care plan is meant to treat Chronic congestive heart failure (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "736353004",
"display": "Inpatient care plan (record artifact)"
}
],
"text": "Inpatient care plan (record artifact)"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"period": {
"start": "1975-04-07T02:42:45-04:00",
"end": "1975-04-08T03:25:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/283"
}
],
"addresses": [
{
"reference": "Condition/260"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "3715006",
"display": "Cardiac care (regime/therapy)"
}
],
"text": "Cardiac care (regime/therapy)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386619000",
"display": "Low sodium diet (finding)"
}
],
"text": "Low sodium diet (finding)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "735",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Head injury rehabilitation.<br/>Activities: <ul><li>Head injury rehabilitation</li><li>Head injury rehabilitation</li></ul><br/>Care plan is meant to treat Concussion with no loss of consciousness.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "47387005",
"display": "Head injury rehabilitation"
}
],
"text": "Head injury rehabilitation"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/732"
},
"period": {
"start": "2015-04-15T20:55:18-04:00",
"end": "2015-06-14T20:55:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/734"
}
],
"addresses": [
{
"reference": "Condition/733"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183051005",
"display": "Recommendation to rest"
}
],
"text": "Recommendation to rest"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "226138001",
"display": "Alcohol-free diet"
}
],
"text": "Alcohol-free diet"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "482",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Fracture care.<br/>Activities: <ul><li>Fracture care</li><li>Fracture care</li></ul><br/>Care plan is meant to treat Fracture of ankle.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "3691007",
"display": "Fracture care"
}
],
"text": "Fracture care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/479"
},
"period": {
"start": "1956-03-13T19:13:18-05:00",
"end": "1956-04-12T19:13:18-05:00"
},
"careTeam": [
{
"reference": "CareTeam/481"
}
],
"addresses": [
{
"reference": "Condition/480"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183051005",
"display": "Recommendation to rest"
}
],
"text": "Recommendation to rest"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "4080007",
"display": "Physical activity target light exercise"
}
],
"text": "Physical activity target light exercise"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "549",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Diabetes self management plan.<br/>Activities: <ul><li>Diabetes self management plan</li><li>Diabetes self management plan</li></ul><br/>Care plan is meant to treat Prediabetes.</div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "698360004",
"display": "Diabetes self management plan"
}
],
"text": "Diabetes self management plan"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/545"
},
"period": {
"start": "1975-01-30T18:33:18-05:00"
},
"careTeam": [
{
"reference": "CareTeam/548"
}
],
"addresses": [
{
"reference": "Condition/546"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "160670007",
"display": "Diabetic diet"
}
],
"text": "Diabetic diet"
},
"status": "in-progress",
"location": {
"reference": "Location/356",
"display": "PCP170967"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "229065009",
"display": "Exercise therapy"
}
],
"text": "Exercise therapy"
},
"status": "in-progress",
"location": {
"reference": "Location/356",
"display": "PCP170967"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "681",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Musculoskeletal care.<br/>Activities: <ul><li>Musculoskeletal care</li><li>Musculoskeletal care</li></ul><br/>Care plan is meant to treat Osteoarthritis of knee.</div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "408869004",
"display": "Musculoskeletal care"
}
],
"text": "Musculoskeletal care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/678"
},
"period": {
"start": "2006-08-20T19:33:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/680"
}
],
"addresses": [
{
"reference": "Condition/679"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386294003",
"display": "Joint mobility exercises"
}
],
"text": "Joint mobility exercises"
},
"status": "in-progress",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266694003",
"display": "Heat therapy"
}
],
"text": "Heat therapy"
},
"status": "in-progress",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "235",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/231"
},
"period": {
"start": "1964-02-03T00:17:45-05:00",
"end": "1965-06-04T01:11:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/234"
}
],
"addresses": [
{
"reference": "Condition/208"
},
{
"reference": "Condition/232"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "428",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Asthma self management.<br/>Activities: <ul><li>Asthma self management</li><li>Asthma self management</li><li>Asthma self management</li></ul><br/>Care plan is meant to treat Childhood asthma.</div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "699728000",
"display": "Asthma self management"
}
],
"text": "Asthma self management"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/424"
},
"period": {
"start": "1944-09-11T19:33:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/427"
}
],
"addresses": [
{
"reference": "Condition/425"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "710818004",
"display": "Inhaled steroid therapy"
}
],
"text": "Inhaled steroid therapy"
},
"status": "in-progress",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "708409001",
"display": "Home nebulizer therapy"
}
],
"text": "Home nebulizer therapy"
},
"status": "in-progress",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "229298005",
"display": "Breathing control"
}
],
"text": "Breathing control"
},
"status": "in-progress",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "497",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Burn care.<br/>Activities: <ul><li>Burn care</li><li>Burn care</li><li>Burn care</li></ul><br/>Care plan is meant to treat First degree burn.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "133901003",
"display": "Burn care"
}
],
"text": "Burn care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/493"
},
"period": {
"start": "1960-01-22T19:13:18-05:00",
"end": "1960-02-12T19:13:18-05:00"
},
"careTeam": [
{
"reference": "CareTeam/496"
}
],
"addresses": [
{
"reference": "Condition/494"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385949008",
"display": "Dressing change management"
}
],
"text": "Dressing change management"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "440381005",
"display": "Behavior to prevent sun exposure"
}
],
"text": "Behavior to prevent sun exposure"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "439830001",
"display": "Behavior to prevent infection"
}
],
"text": "Behavior to prevent infection"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "307",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Inpatient care plan (record artifact).<br/>Activities: <ul><li>Inpatient care plan (record artifact)</li><li>Inpatient care plan (record artifact)</li></ul><br/>Care plan is meant to treat Chronic congestive heart failure (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "736353004",
"display": "Inpatient care plan (record artifact)"
}
],
"text": "Inpatient care plan (record artifact)"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/301"
},
"period": {
"start": "1977-03-28T02:25:45-05:00",
"end": "1977-03-30T03:17:45-05:00"
},
"careTeam": [
{
"reference": "CareTeam/306"
}
],
"addresses": [
{
"reference": "Condition/260"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385715006",
"display": "Cardiac care (regime/therapy)"
}
],
"text": "Cardiac care (regime/therapy)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386619000",
"display": "Low sodium diet (finding)"
}
],
"text": "Low sodium diet (finding)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "438",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/435"
},
"period": {
"start": "1946-08-24T19:42:18-04:00",
"end": "1947-08-28T19:33:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/437"
}
],
"addresses": [
{
"reference": "Condition/398"
},
{
"reference": "Condition/408"
},
{
"reference": "Condition/436"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "760",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Fracture care.<br/>Activities: <ul><li>Fracture care</li><li>Fracture care</li></ul><br/>Care plan is meant to treat Fracture subluxation of wrist.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385691007",
"display": "Fracture care"
}
],
"text": "Fracture care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/756"
},
"period": {
"start": "2018-02-28T20:26:18-05:00",
"end": "2018-03-30T21:26:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/759"
}
],
"addresses": [
{
"reference": "Condition/757"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183051005",
"display": "Recommendation to rest"
}
],
"text": "Recommendation to rest"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "408580007",
"display": "Physical activity target light exercise"
}
],
"text": "Physical activity target light exercise"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "697",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Cancer care plan.<br/>Activities: <ul><li>Cancer care plan</li><li>Cancer care plan</li><li>Cancer care plan</li></ul><br/>Care plan is meant to treat Overlapping malignant neoplasm of colon.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "395082007",
"display": "Cancer care plan"
}
],
"text": "Cancer care plan"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/694"
},
"period": {
"start": "2007-11-27T22:11:18-05:00",
"end": "2009-10-14T23:11:18-04:00"
},
"careTeam": [
{
"reference": "CareTeam/696"
}
],
"addresses": [
{
"reference": "Condition/695"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "226234005",
"display": "Healthy diet"
}
],
"text": "Healthy diet"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "703993001",
"display": "Colonoscopy planned"
}
],
"text": "Colonoscopy planned"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "243072006",
"display": "Cancer education"
}
],
"text": "Cancer education"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "700",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Major surgery care management.<br/>Activities: <ul><li>Major surgery care management</li><li>Major surgery care management</li></ul><br/>Care plan is meant to treat Overlapping malignant neoplasm of colon.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "781831000000109",
"display": "Major surgery care management"
}
],
"text": "Major surgery care management"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/698"
},
"period": {
"start": "2007-12-04T22:11:18-05:00",
"end": "2007-12-24T22:11:18-05:00"
},
"careTeam": [
{
"reference": "CareTeam/699"
}
],
"addresses": [
{
"reference": "Condition/695"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "10888001",
"display": "Liquid diet"
}
],
"text": "Liquid diet"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "103744005",
"display": "Administration of intravenous fluids"
}
],
"text": "Administration of intravenous fluids"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}
{
"resourceType": "CarePlan",
"id": "508",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/505"
},
"period": {
"start": "1963-08-12T19:56:18-04:00",
"end": "1963-11-28T18:33:18-05:00"
},
"careTeam": [
{
"reference": "CareTeam/507"
}
],
"addresses": [
{
"reference": "Condition/398"
},
{
"reference": "Condition/408"
},
{
"reference": "Condition/436"
},
{
"reference": "Condition/460"
},
{
"reference": "Condition/506"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/367",
"display": "HOLYOKE MEDICAL CENTER"
}
}
}
]
}