# Oystehr Documentation
> The complete health tech developer platform
Append .md to any documentation page URL to get its markdown version.
## API Reference
- [Get applications](https://api-reference.oystehr.com/reference/get_application.md): Get a list of Applications. [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) provide authentication in front of the web and mobile apps you build on Oystehr. Access Policy Action: `App:ListAllApplications` Access Policy Resource: `App:Application`
- [Create an application](https://api-reference.oystehr.com/reference/post_application.md): Create a new Application. [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) provide authentication in front of the web and mobile apps you build on Oystehr. Access Policy Action: `App:CreateApplication` Access Policy Resource: `App:Application`
- [Delete an application](https://api-reference.oystehr.com/reference/delete_application-id.md): Delete the Application with the provided ID. [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) provide authentication in front of the web and mobile apps you build on Oystehr. Access Policy Action: `App:DeleteApplication` Access Policy Resource: `App:Application`
- [Get an application](https://api-reference.oystehr.com/reference/get_application-id.md): Get the Application with the provided ID. [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) provide authentication in front of the web and mobile apps you build on Oystehr. Access Policy Action: `App:GetApplication` Access Policy Resource: `App:Application`
- [Update an application](https://api-reference.oystehr.com/reference/patch_application-id.md): Update the Application with the provided ID. [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) provide authentication in front of the web and mobile apps you build on Oystehr. Access Policy Action: `App:UpdateApplication` Access Policy Resource: `App:Application`
- [Rotate application's secret](https://api-reference.oystehr.com/reference/post_application-id-rotate-secret.md): Rotate client's secrete associated with an application. Access Policy Action: `App:RotateApplicationSecret` Access Policy Resource: `App:Application`
- [Revokes user's refresh token](https://api-reference.oystehr.com/reference/post_application-id-revoke-refresh-token.md): Revokes user's refresh token issued for the application. Access Policy Action: `App:RevokeRefreshToken` Access Policy Resource: `App:Application`
- [Revokes user's access token](https://api-reference.oystehr.com/reference/post_application-id-revoke-access-token.md): Revokes user's access token issued for the application. Access Policy Action: `App:RevokeAccessToken` Access Policy Resource: `App:Application`
- [Get a developer by ID](https://api-reference.oystehr.com/reference/get_developer-id.md): Get the Developer with the provided ID. Developer accounts are used to log into the [Developer Console](https://console.oystehr.com/) and administrate [Projects](https://docs.oystehr.com/oystehr/services/project/). [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/) are the only people who can belong to and act across multiple Projects, because they exist above the Project level. Access Policy Action: `IAM:GetDeveloper` Access Policy Resource: `IAM:Developer`
- [Update a developer](https://api-reference.oystehr.com/reference/patch_developer-id.md): Update the Developer with the provided ID. Developer accounts are used to log into the [Developer Console](https://console.oystehr.com/) and administrate [Projects](https://docs.oystehr.com/oystehr/services/project/). [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/) are the only people who can belong to and act across multiple Projects, because they exist above the Project level. Access Policy Action: `IAM:UpdateDeveloper` Access Policy Resource: `IAM:Developer`
- [Remove a developer](https://api-reference.oystehr.com/reference/delete_developer-id.md): Remove the Developer with the provided ID from the project. Developer accounts are used to log into the [Developer Console](https://console.oystehr.com/) and administrate [Projects](https://docs.oystehr.com/oystehr/services/project/). [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/) are the only people who can belong to and act across multiple Projects, because they exist above the Project level. Access Policy Action: `IAM:RemoveDeveloper` Access Policy Resource: `IAM:Developer`
- [Invite a developer](https://api-reference.oystehr.com/reference/post_developer-invite.md): Invite a new Developer to the Project. Developer accounts are used to log into the [Developer Console](https://console.oystehr.com/) and administrate [Projects](https://docs.oystehr.com/oystehr/services/project/). [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/) are the only people who can belong to and act across multiple Projects, because they exist above the Project level. Access Policy Action: `IAM:InviteDeveloper` Access Policy Resource: `IAM:Developer`
- [Get all developers](https://api-reference.oystehr.com/reference/get_developer.md): DEPRECATED. Please use [v2/list](https://api-reference.oystehr.com/reference/get_developer-v2-list) instead. Get a list of all Developers who are part of the Project. Developer accounts are used to log into the [Developer Console](https://console.oystehr.com/) and administrate [Projects](https://docs.oystehr.com/oystehr/services/project/). [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/) are the only people who can belong to and act across multiple Projects, because they exist above the Project level. Access Policy Action: `IAM:ListAllDevelopers` Access Policy Resource: `IAM:Developer`
- [Get developers with pagination](https://api-reference.oystehr.com/reference/get_developer-v2-list.md): Get Developers in the Project with pagination, sort, sort order and filtering. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `Project:ListAllUsers` Access Policy Resource: `Project:Settings`
- [Create an M2M client](https://api-reference.oystehr.com/reference/post_m2m.md): Create a new M2M Client. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda). Access Policy Action: `App:CreateM2MClient` Access Policy Resource: `IAM:M2MClient`
- [Get all M2M clients](https://api-reference.oystehr.com/reference/get_m2m.md): DEPRECATED. Please use [v2/list](https://api-reference.oystehr.com/reference/get_m2m-v2-list) instead. Get a list of all M2M Clients. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda). Access Policy Action: `App:ListAllM2MClients` Access Policy Resource: `IAM:M2MClient`
- [Get an M2M client](https://api-reference.oystehr.com/reference/get_m2m-id.md): Get the M2M Client with the provided ID. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda). Access Policy Action: `App:GetM2MClient` Access Policy Resource: `IAM:M2MClient`
- [Get calling M2M info](https://api-reference.oystehr.com/reference/get_m2m-me.md): Get information about the calling M2M Client. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda). Access Policy Action: `App:GetM2MClient` Access Policy Resource: `IAM:M2MClient`
- [Delete an M2M client](https://api-reference.oystehr.com/reference/delete_m2m-id.md): Delete the M2M Client with the provided ID. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda). Access Policy Action: `App:DeleteM2MClient` Access Policy Resource: `IAM:M2MClient`
- [Update an M2M client](https://api-reference.oystehr.com/reference/patch_m2m-id.md): Update the M2M Client with the provided ID. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda). Access Policy Action: `App:UpdateM2MClient` Access Policy Resource: `IAM:M2MClient`
- [Rotate an M2M client secret](https://api-reference.oystehr.com/reference/post_m2m-id-rotate-secret.md): Rotate the client secret for the M2M Client with the provided ID. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda). Access Policy Action: `App:RotateM2MClientSecret` Access Policy Resource: `IAM:M2MClient`
- [Get M2M clients with pagination](https://api-reference.oystehr.com/reference/get_m2m-v2-list.md): Get M2M clients in the Project with pagination, sort, sort order and filtering. [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients) are used to access Oystehr APIs from scripts and server-side code like [Zambda Functions](https://docs.oystehr.com/oystehr/services/zambda). Access Policy Action: `App:ListAllM2MClients` Access Policy Resource: `IAM:M2MClient`
- [Get a Messaging Services configuration](https://api-reference.oystehr.com/reference/get_messaging-config.md): Get an information about the Messaging services configuration. This information includes phone number, phone number type and also rate limits of each service.
- [Create a Conversation](https://api-reference.oystehr.com/reference/post_messaging-conversation.md): Create a new Conversation. [Conversations](https://docs.oystehr.com/oystehr/services/messaging/conversations/) allow you to build multi-channel bi-directional messaging workflows. For example, you might create a Conversation where a provider messages with a patient through a web app, and the patient receives and responds to messages via SMS on their phone. Access Policy Requirements: Action: `Messaging:CreateConversation` Access Policy Resource: `Messaging:Conversation` Action: `FHIR:Create` Access Policy Resource: `FHIR:Encounter` Action: `FHIR:Update` Access Policy Resource: `FHIR:Encounter`
- [Get a Conversation Token](https://api-reference.oystehr.com/reference/get_messaging-conversation-token.md): Get a Conversation Token. Conversation Tokens are used to join the Conversation with the Twilio Conversations SDKs. [Conversations](https://docs.oystehr.com/oystehr/services/messaging/conversations/) allow you to build multi-channel bi-directional messaging workflows. For example, you might create a Conversation where a provider messages with a patient through a web app, and the patient receives and responds to messages via SMS on their phone. Access Policy Action: `Messaging:GetConversationToken` Access Policy Resource: `Messaging:Conversation`.
- [Add a participant to a Conversation](https://api-reference.oystehr.com/reference/post_messaging-conversation-conversationid-participant.md): Add a participant to a Conversation. [Conversations](https://docs.oystehr.com/oystehr/services/messaging/conversations/) allow you to build multi-channel bi-directional messaging workflows. For example, you might create a Conversation where a provider messages with a patient through a web app, and the patient receives and responds to messages via SMS on their phone. Access Policy Requirements: Action: `Messaging:ConversationAddParticipant` Access Policy Resource: `Messaging:Conversation` Action: `FHIR:Read` Access Policy Resource: `FHIR:Encounter` Action: `FHIR:Update` Access Policy Resource: `FHIR:Encounter`
- [Remove a participant from a Conversation](https://api-reference.oystehr.com/reference/delete_messaging-conversation-conversationid-participant.md): Remove a participant from a Conversation. [Conversations](https://docs.oystehr.com/oystehr/services/messaging/conversations/) allow you to build multi-channel bi-directional messaging workflows. For example, you might create a Conversation where a provider messages with a patient through a web app, and the patient receives and responds to messages via SMS on their phone. Access Policy Requirements: Action: `Messaging:ConversationRemoveParticipant` Access Policy Resource: `Messaging:Conversation` Action: `FHIR:Read` Access Policy Resource: `FHIR:Patient`, `FHIR:Practitioner`, or `FHIR:RelatedPerson`
- [Send a message to a Conversation](https://api-reference.oystehr.com/reference/post_messaging-conversation-conversationid-message.md): Send a message to a Conversation. [Conversations](https://docs.oystehr.com/oystehr/services/messaging/conversations/) allow you to build multi-channel bi-directional messaging workflows. For example, you might create a Conversation where a provider messages with a patient through a web app, and the patient receives and responds to messages via SMS on their phone. Access Policy Requirements: Action: `Messaging:ConversationSendMessage` Access Policy Resource: `Messaging:Conversation`
- [Send a user an SMS](https://api-reference.oystehr.com/reference/post_messaging-transactional-sms-send.md): Send an SMS to any phone number. Oystehr's [Transactional SMS](https://docs.oystehr.com/oystehr/services/messaging/transactional-sms/) feature makes it easy to send a text message to your [Users](https://docs.oystehr.com/oystehr/services/app/users/) with a single API call. You can use this feature to send appointment reminders, prescription refill reminders, discharge information, and more. Access Policy Requirements: Action: `Messaging:SendTransactionalSMS` Access Policy Resource: `Messaging:TransactionalSMS` Action: `FHIR:Create` Access Policy Resource: `FHIR:Communication` Action: `FHIR:Update` Access Policy Resource: `FHIR:Communication` You also need Read access for the resource to which you are sending a message. For example: Action: `FHIR:Read` Access Policy Resource: `FHIR:Patient`
- [Set up a new payment method for user](https://api-reference.oystehr.com/reference/post_payment-payment-method-setup.md): Enter a new credit card or other payment method for the user. Access Policy Requirements: Action: `Payment:Setup` Access Policy Resource: `Payment:PaymentMethod` Actions: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:Coverage:*` Action: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:Account:*` Also need to be able to read the patients' details. For example: Action: `FHIR:Read` Access Policy Resource: `FHIR:Patient`
- [Set a specified method as a default for the user](https://api-reference.oystehr.com/reference/post_payment-payment-method-set-default.md): Set a specified payment method for the user as default. Access Policy Requirements: Action: `Payment:SetDefault` Access Policy Resource: `Payment:PaymentMethod` Actions: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:Coverage:*` Action: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:Account:*` Also need to be able to read the patients' details. For example: Action: `FHIR:Read` Access Policy Resource: `FHIR:Patient`
- [Delete payment method as a default for the beneficiary](https://api-reference.oystehr.com/reference/delete_payment-payment-method.md): Delete a specified payment method for the beneficiary. Access Policy Requirements: Action: `Payment:Delete` Access Policy Resource: `Payment:PaymentMethod` Actions: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:Coverage:*` Action: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:Account:*` Also need to be able to read the patients' details. For example: Action: `FHIR:Read` Access Policy Resource: `FHIR:Patient`
- [List all payment methods for the patient](https://api-reference.oystehr.com/reference/post_payment-payment-method-list.md): List all payment methods for the patient. Access Policy Requirements: Action: `Payment:Setup` Access Policy Resource: `Payment:PaymentMethod` Actions: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:Coverage:*` Action: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:Account:*` Also need to be able to read the patients' details. For example: Action: `FHIR:Read` Access Policy Resource: `FHIR:Patient`
- [Issue a charge for a paricutlar encounter.](https://api-reference.oystehr.com/reference/post_payment-charge-issue.md): Charge patient's default payment method for a specified encounter or charge item. Access Policy Requirements: Action: `Payment:Issue` Access Policy Resource: `Payment:Charge` Actions: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:ChargeItem:*,`FHIR:PaymentReconciliation:*` Action: `FHIR:Read` Access Policy Resources: `FHIR:Patient:*,FHIR:Encounter:*,FHIR:Coverage:*`
- [Retrieve charge status for a paricutlar encounter.](https://api-reference.oystehr.com/reference/post_payment-charge-status.md): Retrieve charge status for a specified encounter or charge item. Access Policy Requirements: Action: `Payment:Status` Access Policy Resource: `Payment:Charge` Actions: `FHIR:Read,FHIR:Create,FHIR:Update` Access Policy Resource: `FHIR:ChargeItem:*,`FHIR:PaymentReconciliation:*` Action: `FHIR:Read` Access Policy Resources: `FHIR:Patient:*,FHIR:Encounter:*,FHIR:Coverage:*`
- [Get project settings](https://api-reference.oystehr.com/reference/get_project.md): Get the Project settings for a Project. Developers must specify a [project ID](https://docs.oystehr.com/oystehr/core-documentation/authenticating-api-requests/#x-oystehr-project-id-header) in the header. A Project is the logically-isolated instance of Oystehr that segments your data from other Projects. [Projects](https://docs.oystehr.com/oystehr/services/project/) are completely independent from each other, having their own separate [FHIR store](https://docs.oystehr.com/oystehr/services/fhir/basics/), [Applications](https://docs.oystehr.com/oystehr/services/app/applications/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), etc . Access Policy Action: `Project:GetProjectInfo` Access Policy Resource: `Project:Settings`
- [Update project settings](https://api-reference.oystehr.com/reference/patch_project.md): Update the Project settings for the Project that corresponds to the project-id in the request header. A [Project](https://docs.oystehr.com/oystehr/services/project/) is the logically-isolated instance of Oystehr that segments your data from other Projects. Projects are completely independent from each other, having their own separate [FHIR store](https://docs.oystehr.com/oystehr/services/fhir/basics/), [Applications](https://docs.oystehr.com/oystehr/services/app/applications/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), etc . Access Policy Action: `Project:UpdateProjectInfo` Access Policy Resource: `Project:Settings`
- [Create a new Role](https://api-reference.oystehr.com/reference/post_iam-role.md): Create a new Role. A [Role](https://docs.oystehr.com/oystehr/services/iam/roles/) defines an access policy that can be assigned to any number of [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), and [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients/). Access Policy Action: `IAM:CreateRole` Access Policy Resource: `IAM:Role`
- [Get all Roles](https://api-reference.oystehr.com/reference/get_iam-role.md): Get a list of all Roles. A [Role](https://docs.oystehr.com/oystehr/services/iam/roles/) defines an access policy that can be assigned to any number of [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), and [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients/). Access Policy Action: `IAM:ListAllRoles` Access Policy Resource: `IAM:Role`
- [Get a Role by ID](https://api-reference.oystehr.com/reference/get_iam-role-roleid.md): Get the Role with the provided ID. A [Role](https://docs.oystehr.com/oystehr/services/iam/roles/) defines an access policy that can be assigned to any number of [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), and [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients/). Access Policy Action: `IAM:GetRole` Access Policy Resource: `IAM:Role`
- [Update a Role](https://api-reference.oystehr.com/reference/patch_iam-role-roleid.md): Update the Role with the provided ID. A [Role](https://docs.oystehr.com/oystehr/services/iam/roles/) defines an access policy that can be assigned to any number of [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), and [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients/). Access Policy Action: `IAM:UpdateRole` Access Policy Resource: `IAM:Role`
- [Delete a role](https://api-reference.oystehr.com/reference/delete_iam-role-roleid.md): Delete the Role with the provided ID. A [Role](https://docs.oystehr.com/oystehr/services/iam/roles/) defines an access policy that can be assigned to any number of [Developers](https://docs.oystehr.com/oystehr/services/iam/developers/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), and [M2M Clients](https://docs.oystehr.com/oystehr/services/iam/m2m-clients/). Access Policy Action: `IAM:DeleteRole` Access Policy Resource: `IAM:Role` Will fail if any entities hold the Role or if Role is assigned as the default patient role for the project
- [Create secret](https://api-reference.oystehr.com/reference/post_secret.md): Create a secret for a project. If the secret is already defined, update it. Access Policy Action: `Zambda:CreateSecret` Access Policy Resource: `Zambda:Secret`
- [Get all Secrets](https://api-reference.oystehr.com/reference/get_secret.md): Get a list of all secrets in the Project. Access Policy Action: `Zambda:ListAllSecrets` Access Policy Resource: `Zambda:Secret`
- [Get a Secret](https://api-reference.oystehr.com/reference/get_secret-name.md): Get the secret with the provided name. Access Policy Action: `Zambda:GetSecret` Access Policy Resource: `Zambda:Secret`
- [Delete a Secret](https://api-reference.oystehr.com/reference/delete_secret-name.md): Delete the secret with the provided name. Access Policy Action: `Zambda:DeleteSecret` Access Policy Resource: `Zambda:Secret`
- [Create a telemedicine video meeting](https://api-reference.oystehr.com/reference/post_telemed-v2-meeting.md): Create a [telemedicine video meeting](https://docs.oystehr.com/oystehr/services/telemed/). Access Policy Requirements: Action: `Telemed:CreateMeeting` Access Policy Resource: `Telemed:Meeting` Action: `FHIR:Create` Access Policy Resource: `FHIR:Encounter` Action: `FHIR:Update` Access Policy Resource: `FHIR:Encounter`
- [Join a video meeting](https://api-reference.oystehr.com/reference/get_telemed-v2-meeting-encounterid-join.md): Get Meeting and Attendee objects necessary to join a telemedicine video meeting. Access Policy Requirements: Action: `Telemed:JoinMeeting` Access Policy Resource: `Telemed:Meeting` To use M2M token to join as anonymous user: Action: `Telemed:AddAnonymousToMeeting` Access Policy Resource: `Telemed:Meeting`
- [End a telemedicine video meeting](https://api-reference.oystehr.com/reference/delete_telemed-v2-meeting-encounterid.md): Immediately end an active telemedicine video meeting. The caller must be a participant of the Encounter. Ending the meeting triggers the downstream recording pipeline without waiting for the room to time out, making audio recordings and transcriptions available much sooner after the call. Access Policy Requirements: Action: `Telemed:EndMeeting` Access Policy Resource: `Telemed:Meeting`
- [Get yourself](https://api-reference.oystehr.com/reference/get_user-me-1.md): Get your own User details. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Fetch details about the calling User. This endpoint has no access policy requirements, it is available to all authenticated Users.
- [Get a User by ID](https://api-reference.oystehr.com/reference/get_user-id.md): Get the User with the provided ID. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `App:GetUser` Access Policy Resource: `App:User`
- [Update a specific user](https://api-reference.oystehr.com/reference/patch_user-id.md): Update the User with the provided ID. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `App:UpdateUser` Access Policy Resource: `App:User`
- [Delete a specific user](https://api-reference.oystehr.com/reference/delete_user-id.md): Delete the User with the provided ID. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `App:DeleteUser` Access Policy Resource: `App:User`
- [Invite a User](https://api-reference.oystehr.com/reference/post_user-invite.md): Invite a User to the Project. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `App:CreateUser` Access Policy Resource: `App:User`
- [Reset a User's MFA by ID](https://api-reference.oystehr.com/reference/post_user-id-reset-mfa.md): Reset MFA for the User with the provided ID. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `App:ResetUserMFA` Access Policy Resource: `App:User`
- [Get all users](https://api-reference.oystehr.com/reference/get_user.md): DEPRECATED. Please use [v2/list](https://api-reference.oystehr.com/reference/get_user-v2-list) instead. Get all Users in the Project. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `App:ListAllUsers` Access Policy Resource: `App:User`
- [Create a password reset link for a User by ID](https://api-reference.oystehr.com/reference/post_user-id-reset-password-link.md): Creates a password reset link for the User with the provided ID. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `App:GetUserPasswordResetLink` Access Policy Resource: `App:User`
- [Get users with pagination](https://api-reference.oystehr.com/reference/get_user-v2-list.md): Get Users in the Project with pagination, sort, sort order and filtering. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `Project:ListAllUsers` Access Policy Resource: `Project:Settings`
- [Change password for a User by ID](https://api-reference.oystehr.com/reference/post_user-id-change-password.md): Automatically changes the password for the User with the provided ID. [Users](https://docs.oystehr.com/oystehr/services/app/users/) are the people who log into the [Applications](https://docs.oystehr.com/oystehr/services/app/applications/) you configure for securing the apps you build on top of Oystehr. Access Policy Action: `App:ChangeUserPassword` Access Policy Resource: `App:User`
- [Get project API version](https://api-reference.oystehr.com/reference/get_version-1.md): Get project API version. This endpoint is public so there are no access policy requirements.
- [List all Z3 Buckets](https://api-reference.oystehr.com/reference/get_z3.md): List all Z3 Buckets. [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage. Access Policy Action: `Z3:ListBuckets` Access Policy Resource: `Z3:BucketName`
- [Create a Z3 Bucket](https://api-reference.oystehr.com/reference/put_z3-bucketname.md): Create a Z3 Bucket with the provided name. [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage. Access Policy Action: `Z3:CreateBucket` Access Policy Resource: `Z3:*`
- [Delete a Z3 Bucket](https://api-reference.oystehr.com/reference/delete_z3-bucketname.md): Delete the Z3 Bucket with the provided name. [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage. Access Policy Action: `Z3:DeleteBucket` Access Policy Resource: `Z3:BucketName`
- [List Z3 Objects in a Bucket](https://api-reference.oystehr.com/reference/get_z3-bucketname-objectpath.md): List all Z3 Objects at the provided path in the Bucket with the provided name [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage. Access Policy Action: `Z3:ListObjects` Access Policy Resource: `Z3:BucketName:ObjectPath`
- [Empty a Z3 Bucket](https://api-reference.oystehr.com/reference/delete_z3-bucketname-objects.md): Recursively delete all Z3 Objects in the Bucket with the provided name. [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage. Access Policy Action: `Z3:EmptyBucket` Access Policy Resource: `Z3:BucketName`
- [Delete a Z3 Object](https://api-reference.oystehr.com/reference/delete_z3-bucketname-objectpath.md): Delete the Z3 Object at the provided path in the Bucket with the provided name. [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage. Access Policy Action: `Z3:DeleteObject` Access Policy Resource: `Z3:BucketName:ObjectPath`
- [Get a link for uploading or downloading a Z3 Object](https://api-reference.oystehr.com/reference/post_z3-bucketname-objectpath.md): Get a link for downloading or uploading a Z3 Object to the provided path in the Bucket with the provided name. [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage. Access Policy Action: `Z3:PutObject` or `Z3:GetObject` Access Policy Resource: `Z3:BucketName:ObjectPath`
- [Offboard a fax number](https://api-reference.oystehr.com/reference/post_offboard.md): Offboard a fax number. Oystehr's [offboard](https://docs.oystehr.com/oystehr/services/fax/number/) feature makes it easy to stop using the fax service and release the project's assigned fax number with a single API call. Please note there is no way to guarantee getting the same number back again, so if you think this can break your project in any way we recommend not offboarding and avoid sending faxes until you're sure. Access Policy Requirements: Action: `Fax:Offboard` Access Policy Resource: `Fax:Number`
- [Onboard a fax number](https://api-reference.oystehr.com/reference/post_onboard.md): Onboard a fax number. Oystehr's [onboard](https://docs.oystehr.com/oystehr/services/fax/number/) feature makes it easy to start using the fax service and purchase a new fax number for your project with a single API call. Access Policy Requirements: Action: `Fax:Onboard` Access Policy Resource: `Fax:Number`
- [Send a fax](https://api-reference.oystehr.com/reference/post_send.md): Send a fax. Oystehr's [fax sending](https://docs.oystehr.com/oystehr/services/fax/send/) feature makes it easy to send a fax to a chosen recipient with a single API call. You can use this feature to send referrals, medical records, prescriptions, and other documents that require fax transmission e.g. for HIPAA compliance. Access Policy Requirements: Action: `Fax:Send` Access Policy Resource: `Fax:Fax`
- [Get fax service configuration](https://api-reference.oystehr.com/reference/get_config-1.md): Get fax service configuration. Access Policy Requirements: Action: `Fax:GetConfiguration` Access Policy Resource: `Fax:Configuration`
- [Get Routes](https://api-reference.oystehr.com/reference/get_route.md): Gets a list of Routes associated with the project. Returns an empty list if no Routes are found. Access Policy Requirements: Action: `Lab:GetRoutes` Access Policy Resource: `Lab:Route`
- [Create a Route](https://api-reference.oystehr.com/reference/post_route.md): Create a route. A Route represents that a lab and particular customer have a relationship, and a Route is necessary to submit an order to a lab. See [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details. Access Policy Requirements: Action: `Lab:CreateRoute` Access Policy Resource: `Lab:Route`
- [Delete a Route](https://api-reference.oystehr.com/reference/delete_route-routeguid.md): Delete a route. Deleting a Route will permanently remove the `routeGuid`. Orders can no longer be submitted to this lab until a new Route is created. See [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#delete-route) for more details. Access Policy Requirements: Action: `Lab:DeleteRoute` Access Policy Resource: `Lab:Route`
- [Get single Route](https://api-reference.oystehr.com/reference/get_route-routeguid.md): Gets a Route associated with the project by specified Guid. Access Policy Requirements: Action: `Lab:GetSingleRoute` Access Policy Resource: `Lab:Route`
- [Search for orderable items](https://api-reference.oystehr.com/reference/get_orderableitem.md): Returns list of active orderable items for the latest compendium version. Page size is default 25 and max 100 items. See [orderable item Search](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#orderable-item-search) for more details. Access Policy Requirements: Action: `Lab:SearchOrderableItems` Access Policy Resource: `Lab:OrderableItem`
- [Get AOE Questionnaire](https://api-reference.oystehr.com/reference/get_canonical-questionnaire-lab-labguid-compendium-compendiumversion-item-itemcode-questionnaire.md): Retrieve the AOE (Answer on Entry) Questionnaire for the given orderable item. The orderable item is defined by its labGuid, compendiumVersion, and itemCode. See [AOE](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#AOE) for more details. Access Policy Requirements: Action: `Lab:SearchOrderableItems` Access Policy Resource: `Lab:OrderableItem`
- [Submit a lab order](https://api-reference.oystehr.com/reference/post_submit.md): Submit a lab order. Oystehr's [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/) feature allows users to submit an order consisting of one or more well-configured ServiceRequests to an external lab. In order to successfully submit an order, a [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) to and Organization representing that lab must exist. If the lab requires its own requisition document (eReq) or an Advance Beneficiary Notice (ABN), the appropriate DocumentReferences will be included in the response. Access Policy Requirements: Action: `Lab:SubmitOrder` Access Policy Resource: `Lab:Order`
- [Search for allergens](https://api-reference.oystehr.com/reference/get_allergen.md): Search for allergens. Action: `eRx:SearchAllergen` Access Policy Resource: `eRx:Allergen`
- [Search for medications](https://api-reference.oystehr.com/reference/get_medication-1.md): Search for medications. Action: `eRx:SearchMedication` Access Policy Resource: `eRx:Medication`
- [Check for drug-allergy interactions](https://api-reference.oystehr.com/reference/get_patient-patientid-interactions-allergy.md): Check for drug-allergy interactions for a patient. This endpoint requires the patient's allergies to be synced with the upstream eRx provider. Action: `eRx:Check` Access Policy Resource: `eRx:Interaction`
- [Get project configuration](https://api-reference.oystehr.com/reference/get_config.md): Get eRx configuration for project. Action: `eRx:GetConfiguration` Access Policy Resource: `eRx:Configuration`
- [Retrieve information about a medication](https://api-reference.oystehr.com/reference/get_medication-details.md): Get full medication details. Action: `eRx:GetMedication` Access Policy Resource: `eRx:Medication`
- [Check for drug-drug interactions](https://api-reference.oystehr.com/reference/get_patient-patientid-interactions-medication.md): Check for drug-drug interactions for a patient. This endpoint requires the patient's medications to be synced with the upstream eRx provider. Action: `eRx:Check` Access Policy Resource: `eRx:Interaction`
- [Check for drug-allergy and drug-drug interactions with a specific drug](https://api-reference.oystehr.com/reference/get_patient-patientid-interactions-precheck-drugid.md): Check for drug-allergy and drug-drug interactions with a specific drug for a patient. This endpoint requires the patient's allergies and medications to be synced with the upstream eRx provider. Action: `eRx:Check` Access Policy Resource: `eRx:Interaction`
- [Sync patient data with upstream eRx provider](https://api-reference.oystehr.com/reference/post_patient-patientid-sync.md): Syncs demographic, allergy, and medication data for a patient with the upstream eRx provider. Action: `eRx:SyncPatient` Access Policy Resource: `eRx:Patient`
- [Cancel patient's prescription](https://api-reference.oystehr.com/reference/delete_patient-patientid-prescriptions-medicationrequestid.md): Cancel prescription for patient. Action: `eRx:CancelPrescription` Access Policy Resource: `eRx:Prescription`
- [Create an SSO link for a practitioner](https://api-reference.oystehr.com/reference/get_practitioner-connect.md): Create an SSO link for a practitioner. This link can be used to log in to the eRx service as the specified practitioner. Action: `eRx:Connect` Access Policy Resource: `eRx:SSO`
- [Add pharmacy to patient in upstream eRx provider](https://api-reference.oystehr.com/reference/post_patient-patientid-pharmacies.md): Adds pharmacy for a patient with the upstream eRx provider, setting it as primary if specified. Action: `eRx:AddPatientPharmacy` Access Policy Resource: `eRx:Patient`
- [Get medication history](https://api-reference.oystehr.com/reference/get_patient-patientid-medication-history.md): Retrieve claims-based medication history for a patient. This endpoint requires the patient to be synced with the upstream eRx provider. Action: `eRx:GetMedicationHistory` Access Policy Resource: `eRx:Patient`
- [Check eRx enrollment and notifications for a practitioner](https://api-reference.oystehr.com/reference/get_practitioner-practitionerid.md): Check eRx enrollment and notifications for a practitioner. Action: `eRx:Read` Access Policy Resource: `eRx:Enrollment`
- [Enroll a practitioner in eRx](https://api-reference.oystehr.com/reference/post_practitioner-practitionerid.md): Enroll a practitioner in the eRx service. Action: `eRx:Create` Access Policy Resource: `eRx:Enrollment`
- [Search pharmacies](https://api-reference.oystehr.com/reference/get_pharmacy.md): Search for pharmacies by a variety of criteria. Action: `eRx:SearchPharmacy` Access Policy Resource: `eRx:Pharmacy`
- [Unenroll a practitioner from eRx](https://api-reference.oystehr.com/reference/delete_practitioner-practitionerid.md): Unenroll a practitioner from the eRx service. Action: `eRx:Delete` Access Policy Resource: `eRx:Enrollment`
- [Get pharmacy by ID](https://api-reference.oystehr.com/reference/get_pharmacy-pharmacyid.md): Get a pharmacy by its eRx pharmacy ID. Action: `eRx:GetPharmacy` Access Policy Resource: `eRx:Pharmacy`
- [Search CPT codes](https://api-reference.oystehr.com/reference/get_cpt-search.md): Search CPT (Current Procedural Terminology) codes by code or description. Supports exact matches, prefix searches, and full-text search with BM25 ranking. Access Policy Action: `Terminology:SearchCodes` Access Policy Resource: `Terminology:Code:*`
- [Search HCPCS codes](https://api-reference.oystehr.com/reference/get_hcpcs-search.md): Search HCPCS (Healthcare Common Procedure Coding System) Level II codes by code or description. Supports exact matches, prefix searches, and full-text search with BM25 ranking. Access Policy Action: `Terminology:SearchCodes` Access Policy Resource: `Terminology:Code:*`
- [Search ICD-10-CM codes](https://api-reference.oystehr.com/reference/get_icd10-search.md): Search ICD-10-CM (International Classification of Diseases, 10th Revision, Clinical Modification) diagnosis codes by code or description. Only billable (leaf-node) codes are returned, including codes expanded with their required seventh character. Supports exact matches, prefix searches, and full-text search with BM25 ranking. Access Policy Action: `Terminology:SearchCodes` Access Policy Resource: `Terminology:Code:*`
- [Search Accounts](https://api-reference.oystehr.com/reference/get_account.md): **[Account on the FHIR specification website.](https://www.hl7.org/fhir/r4b/account.html)** A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
- [Create a new Account](https://api-reference.oystehr.com/reference/post_account.md): **[Account on the FHIR specification website.](https://www.hl7.org/fhir/r4b/account.html)** A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc. The body should be a valid FHIR object for Account. Here is an example: ```json { "resourceType": "Account", "id": "ewg", "text": { "status": "generated", "div": "Inpatient Admission for Peter James Chalmers Account
" }, "identifier": [ { "system": "urn:oid:0.1.2.3.4.5.6.7", "value": "654321" } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "PBILLACCT", "display": "patient billing account" } ], "text": "patient" }, "name": "Inpatient: Peter James Chalmers", "subject": [ { "reference": "Patient/example", "display": "Peter James Chalmers" } ], "servicePeriod": { "start": "2016-01-01", "end": "2016-06-30" }, "coverage": [ { "coverage": { "reference": "Coverage/9876B1" }, "priority": 1 }, { "coverage": { "reference": "Coverage/7546D" }, "priority": 2 } ], "owner": { "reference": "Organization/f001", "display": "Burgers University Medical Center" }, "description": "Hospital charges", "guarantor": [ { "party": { "reference": "RelatedPerson/benedicte", "display": "Bénédicte du Marché" }, "onHold": false, "period": { "start": "2016-01-01" } } ] } ``` You can reference the FHIR documentation to determine the format for [`Account`](https://www.hl7.org/fhir/r4b/Account.html).
- [Search Accounts](https://api-reference.oystehr.com/reference/post_account-search.md): **[Account on the FHIR specification website.](https://www.hl7.org/fhir/r4b/account.html)** A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
- [Get Account with identifier {identifier}](https://api-reference.oystehr.com/reference/get_account-identifier.md): **[Account on the FHIR specification website.](https://www.hl7.org/fhir/r4b/account.html)** A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
- [Update Account with identifier {identifier}](https://api-reference.oystehr.com/reference/put_account-identifier.md): **[Account on the FHIR specification website.](https://www.hl7.org/fhir/r4b/account.html)** A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc. The body should be a valid FHIR object for Account. Here is an example: ```json { "resourceType": "Account", "id": "ewg", "text": { "status": "generated", "div": "Inpatient Admission for Peter James Chalmers Account
" }, "identifier": [ { "system": "urn:oid:0.1.2.3.4.5.6.7", "value": "654321" } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "PBILLACCT", "display": "patient billing account" } ], "text": "patient" }, "name": "Inpatient: Peter James Chalmers", "subject": [ { "reference": "Patient/example", "display": "Peter James Chalmers" } ], "servicePeriod": { "start": "2016-01-01", "end": "2016-06-30" }, "coverage": [ { "coverage": { "reference": "Coverage/9876B1" }, "priority": 1 }, { "coverage": { "reference": "Coverage/7546D" }, "priority": 2 } ], "owner": { "reference": "Organization/f001", "display": "Burgers University Medical Center" }, "description": "Hospital charges", "guarantor": [ { "party": { "reference": "RelatedPerson/benedicte", "display": "Bénédicte du Marché" }, "onHold": false, "period": { "start": "2016-01-01" } } ] } ``` You can reference the FHIR documentation to determine the format for [`Account`](https://www.hl7.org/fhir/r4b/Account.html).
- [Patch Account with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_account-identifier.md): **[Account on the FHIR specification website.](https://www.hl7.org/fhir/r4b/account.html)** A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc. The body should be a list of valid JSON patches for Account. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Account with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_account-identifier.md): **[Account on the FHIR specification website.](https://www.hl7.org/fhir/r4b/account.html)** A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
- [Get history of Account with identifier {identifier}](https://api-reference.oystehr.com/reference/get_account-identifier-history.md): **[Account on the FHIR specification website.](https://www.hl7.org/fhir/r4b/account.html)** A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
- [Get Account with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_account-identifier-history-versionidentifier.md): **[Account on the FHIR specification website.](https://www.hl7.org/fhir/r4b/account.html)** A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
- [Search ActivityDefinitions](https://api-reference.oystehr.com/reference/get_activitydefinition.md): **[ActivityDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/activitydefinition.html)** This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
- [Create a new ActivityDefinition](https://api-reference.oystehr.com/reference/post_activitydefinition.md): **[ActivityDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/activitydefinition.html)** This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. The body should be a valid FHIR object for ActivityDefinition. Here is an example: ```json { "resourceType": "ActivityDefinition", "id": "blood-tubes-supply", "text": { "status": "generated", "div": "\n
" }, "status": "draft", "description": "10 Blood collect tubes blue cap", "purpose": "Describes a request for 10 Blood collection tubes with blue caps.", "usage": "This activity definition is used as the definition of a supply request to resupply blood collection tubes. Elements that apply universally are defined here, while elements that apply to the specific setting of a referral within a particular order set are defined in the order set.", "kind": "SupplyRequest", "code": { "coding": [ { "code": "BlueTubes", "display": "Blood collect tubes blue cap" } ] }, "quantity": { "value": 10 }, "transform": "StructureMap/supplyrequest-transform" } ``` You can reference the FHIR documentation to determine the format for [`ActivityDefinition`](https://www.hl7.org/fhir/r4b/ActivityDefinition.html).
- [Search ActivityDefinitions](https://api-reference.oystehr.com/reference/post_activitydefinition-search.md): **[ActivityDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/activitydefinition.html)** This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
- [Get ActivityDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_activitydefinition-identifier.md): **[ActivityDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/activitydefinition.html)** This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
- [Update ActivityDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_activitydefinition-identifier.md): **[ActivityDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/activitydefinition.html)** This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. The body should be a valid FHIR object for ActivityDefinition. Here is an example: ```json { "resourceType": "ActivityDefinition", "id": "blood-tubes-supply", "text": { "status": "generated", "div": "\n
" }, "status": "draft", "description": "10 Blood collect tubes blue cap", "purpose": "Describes a request for 10 Blood collection tubes with blue caps.", "usage": "This activity definition is used as the definition of a supply request to resupply blood collection tubes. Elements that apply universally are defined here, while elements that apply to the specific setting of a referral within a particular order set are defined in the order set.", "kind": "SupplyRequest", "code": { "coding": [ { "code": "BlueTubes", "display": "Blood collect tubes blue cap" } ] }, "quantity": { "value": 10 }, "transform": "StructureMap/supplyrequest-transform" } ``` You can reference the FHIR documentation to determine the format for [`ActivityDefinition`](https://www.hl7.org/fhir/r4b/ActivityDefinition.html).
- [Patch ActivityDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_activitydefinition-identifier.md): **[ActivityDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/activitydefinition.html)** This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. The body should be a list of valid JSON patches for ActivityDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ActivityDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_activitydefinition-identifier.md): **[ActivityDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/activitydefinition.html)** This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
- [Get history of ActivityDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_activitydefinition-identifier-history.md): **[ActivityDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/activitydefinition.html)** This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
- [Get ActivityDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_activitydefinition-identifier-history-versionidentifier.md): **[ActivityDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/activitydefinition.html)** This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
- [Search AdministrableProductDefinitions](https://api-reference.oystehr.com/reference/get_administrableproductdefinition.md): **[AdministrableProductDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/administrableproductdefinition.html)** A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).
- [Create a new AdministrableProductDefinition](https://api-reference.oystehr.com/reference/post_administrableproductdefinition.md): **[AdministrableProductDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/administrableproductdefinition.html)** A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed). The body should be a valid FHIR object for AdministrableProductDefinition. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`AdministrableProductDefinition`](https://www.hl7.org/fhir/r4b/AdministrableProductDefinition.html).
- [Search AdministrableProductDefinitions](https://api-reference.oystehr.com/reference/post_administrableproductdefinition-search.md): **[AdministrableProductDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/administrableproductdefinition.html)** A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).
- [Get AdministrableProductDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_administrableproductdefinition-identifier.md): **[AdministrableProductDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/administrableproductdefinition.html)** A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).
- [Update AdministrableProductDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_administrableproductdefinition-identifier.md): **[AdministrableProductDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/administrableproductdefinition.html)** A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed). The body should be a valid FHIR object for AdministrableProductDefinition. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`AdministrableProductDefinition`](https://www.hl7.org/fhir/r4b/AdministrableProductDefinition.html).
- [Patch AdministrableProductDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_administrableproductdefinition-identifier.md): **[AdministrableProductDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/administrableproductdefinition.html)** A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed). The body should be a list of valid JSON patches for AdministrableProductDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete AdministrableProductDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_administrableproductdefinition-identifier.md): **[AdministrableProductDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/administrableproductdefinition.html)** A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).
- [Get history of AdministrableProductDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_administrableproductdefinition-identifier-history.md): **[AdministrableProductDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/administrableproductdefinition.html)** A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).
- [Get AdministrableProductDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_administrableproductdefinition-identifier-history-versionidentifier.md): **[AdministrableProductDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/administrableproductdefinition.html)** A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).
- [Search AdverseEvents](https://api-reference.oystehr.com/reference/get_adverseevent.md): **[AdverseEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/adverseevent.html)** Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
- [Create a new AdverseEvent](https://api-reference.oystehr.com/reference/post_adverseevent.md): **[AdverseEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/adverseevent.html)** Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death. The body should be a valid FHIR object for AdverseEvent. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`AdverseEvent`](https://www.hl7.org/fhir/r4b/AdverseEvent.html).
- [Search AdverseEvents](https://api-reference.oystehr.com/reference/post_adverseevent-search.md): **[AdverseEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/adverseevent.html)** Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
- [Get AdverseEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/get_adverseevent-identifier.md): **[AdverseEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/adverseevent.html)** Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
- [Update AdverseEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/put_adverseevent-identifier.md): **[AdverseEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/adverseevent.html)** Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death. The body should be a valid FHIR object for AdverseEvent. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`AdverseEvent`](https://www.hl7.org/fhir/r4b/AdverseEvent.html).
- [Patch AdverseEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_adverseevent-identifier.md): **[AdverseEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/adverseevent.html)** Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death. The body should be a list of valid JSON patches for AdverseEvent. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete AdverseEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_adverseevent-identifier.md): **[AdverseEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/adverseevent.html)** Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
- [Get history of AdverseEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/get_adverseevent-identifier-history.md): **[AdverseEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/adverseevent.html)** Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
- [Get AdverseEvent with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_adverseevent-identifier-history-versionidentifier.md): **[AdverseEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/adverseevent.html)** Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
- [Search AllergyIntolerances](https://api-reference.oystehr.com/reference/get_allergyintolerance.md): **[AllergyIntolerance on the FHIR specification website.](https://www.hl7.org/fhir/r4b/allergyintolerance.html)** Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
- [Create a new AllergyIntolerance](https://api-reference.oystehr.com/reference/post_allergyintolerance.md): **[AllergyIntolerance on the FHIR specification website.](https://www.hl7.org/fhir/r4b/allergyintolerance.html)** Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. The body should be a valid FHIR object for AllergyIntolerance. Here is an example: ```json { "resourceType": "AllergyIntolerance", "id": "fishallergy", "text": { "status": "additional", "div": "\n
allergy is to fresh fish. Tolerates canned fish
\n
recordedDate:2015-08-06T00:00:00-06:00
\n
substance:Fish - dietary (substance)
\n
\n
allergy is to fresh fish. Tolerates canned fish
\n
recordedDate:2015-08-06T00:00:00-06:00
\n
substance:Fish - dietary (substance)
\n
Brian MRI results discussion
" }, "status": "booked", "serviceCategory": [ { "coding": [ { "system": "http://example.org/service-category", "code": "gp", "display": "General Practice" } ] } ], "serviceType": [ { "coding": [ { "code": "52", "display": "General Discussion" } ] } ], "specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "394814009", "display": "General practice" } ] } ], "appointmentType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0276", "code": "WALKIN", "display": "A previously unscheduled walk-in visit" } ] }, "priority": 5, "description": "Discussion about Peter Chalmers MRI results", "supportingInformation": [ { "reference": "DiagnosticReport/ultrasound" } ], "start": "2013-12-09T09:00:00Z", "end": "2013-12-09T11:00:00Z", "comment": "Clarify the results of the MRI to ensure context of test was correct", "participant": [ { "actor": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "required": "information-only", "status": "accepted" }, { "actor": { "reference": "Practitioner/example", "display": "Dr Adam Careful" }, "required": "required", "status": "accepted" }, { "actor": { "reference": "Practitioner/f202", "display": "Luigi Maas" }, "required": "required", "status": "accepted" }, { "actor": { "display": "Phone Call" }, "required": "information-only", "status": "accepted" } ] } ``` You can reference the FHIR documentation to determine the format for [`Appointment`](https://www.hl7.org/fhir/r4b/Appointment.html).
- [Search Appointments](https://api-reference.oystehr.com/reference/post_appointment-search.md): **[Appointment on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointment.html)** A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
- [Get Appointment with identifier {identifier}](https://api-reference.oystehr.com/reference/get_appointment-identifier.md): **[Appointment on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointment.html)** A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
- [Update Appointment with identifier {identifier}](https://api-reference.oystehr.com/reference/put_appointment-identifier.md): **[Appointment on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointment.html)** A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). The body should be a valid FHIR object for Appointment. Here is an example: ```json { "resourceType": "Appointment", "id": "2docs", "text": { "status": "generated", "div": "Brian MRI results discussion
" }, "status": "booked", "serviceCategory": [ { "coding": [ { "system": "http://example.org/service-category", "code": "gp", "display": "General Practice" } ] } ], "serviceType": [ { "coding": [ { "code": "52", "display": "General Discussion" } ] } ], "specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "394814009", "display": "General practice" } ] } ], "appointmentType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0276", "code": "WALKIN", "display": "A previously unscheduled walk-in visit" } ] }, "priority": 5, "description": "Discussion about Peter Chalmers MRI results", "supportingInformation": [ { "reference": "DiagnosticReport/ultrasound" } ], "start": "2013-12-09T09:00:00Z", "end": "2013-12-09T11:00:00Z", "comment": "Clarify the results of the MRI to ensure context of test was correct", "participant": [ { "actor": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "required": "information-only", "status": "accepted" }, { "actor": { "reference": "Practitioner/example", "display": "Dr Adam Careful" }, "required": "required", "status": "accepted" }, { "actor": { "reference": "Practitioner/f202", "display": "Luigi Maas" }, "required": "required", "status": "accepted" }, { "actor": { "display": "Phone Call" }, "required": "information-only", "status": "accepted" } ] } ``` You can reference the FHIR documentation to determine the format for [`Appointment`](https://www.hl7.org/fhir/r4b/Appointment.html).
- [Patch Appointment with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_appointment-identifier.md): **[Appointment on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointment.html)** A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). The body should be a list of valid JSON patches for Appointment. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Appointment with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_appointment-identifier.md): **[Appointment on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointment.html)** A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
- [Get history of Appointment with identifier {identifier}](https://api-reference.oystehr.com/reference/get_appointment-identifier-history.md): **[Appointment on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointment.html)** A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
- [Get Appointment with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_appointment-identifier-history-versionidentifier.md): **[Appointment on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointment.html)** A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
- [Search AppointmentResponses](https://api-reference.oystehr.com/reference/get_appointmentresponse.md): **[AppointmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointmentresponse.html)** A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
- [Create a new AppointmentResponse](https://api-reference.oystehr.com/reference/post_appointmentresponse.md): **[AppointmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointmentresponse.html)** A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. The body should be a valid FHIR object for AppointmentResponse. Here is an example: ```json { "resourceType": "AppointmentResponse", "id": "example", "text": { "status": "generated", "div": "Accept Brian MRI results discussion
" }, "appointment": { "reference": "Appointment/example", "display": "Brian MRI results discussion" }, "actor": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "participantStatus": "accepted" } ``` You can reference the FHIR documentation to determine the format for [`AppointmentResponse`](https://www.hl7.org/fhir/r4b/AppointmentResponse.html).
- [Search AppointmentResponses](https://api-reference.oystehr.com/reference/post_appointmentresponse-search.md): **[AppointmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointmentresponse.html)** A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
- [Get AppointmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/get_appointmentresponse-identifier.md): **[AppointmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointmentresponse.html)** A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
- [Update AppointmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/put_appointmentresponse-identifier.md): **[AppointmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointmentresponse.html)** A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. The body should be a valid FHIR object for AppointmentResponse. Here is an example: ```json { "resourceType": "AppointmentResponse", "id": "example", "text": { "status": "generated", "div": "Accept Brian MRI results discussion
" }, "appointment": { "reference": "Appointment/example", "display": "Brian MRI results discussion" }, "actor": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "participantStatus": "accepted" } ``` You can reference the FHIR documentation to determine the format for [`AppointmentResponse`](https://www.hl7.org/fhir/r4b/AppointmentResponse.html).
- [Patch AppointmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_appointmentresponse-identifier.md): **[AppointmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointmentresponse.html)** A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. The body should be a list of valid JSON patches for AppointmentResponse. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete AppointmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_appointmentresponse-identifier.md): **[AppointmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointmentresponse.html)** A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
- [Get history of AppointmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/get_appointmentresponse-identifier-history.md): **[AppointmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointmentresponse.html)** A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
- [Get AppointmentResponse with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_appointmentresponse-identifier-history-versionidentifier.md): **[AppointmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/appointmentresponse.html)** A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
- [Search AuditEvents](https://api-reference.oystehr.com/reference/get_auditevent.md): **[AuditEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/auditevent.html)** A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
- [Create a new AuditEvent](https://api-reference.oystehr.com/reference/post_auditevent.md): **[AuditEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/auditevent.html)** A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. The body should be a valid FHIR object for AuditEvent. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`AuditEvent`](https://www.hl7.org/fhir/r4b/AuditEvent.html).
- [Search AuditEvents](https://api-reference.oystehr.com/reference/post_auditevent-search.md): **[AuditEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/auditevent.html)** A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
- [Get AuditEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/get_auditevent-identifier.md): **[AuditEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/auditevent.html)** A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
- [Update AuditEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/put_auditevent-identifier.md): **[AuditEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/auditevent.html)** A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. The body should be a valid FHIR object for AuditEvent. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`AuditEvent`](https://www.hl7.org/fhir/r4b/AuditEvent.html).
- [Patch AuditEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_auditevent-identifier.md): **[AuditEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/auditevent.html)** A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. The body should be a list of valid JSON patches for AuditEvent. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete AuditEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_auditevent-identifier.md): **[AuditEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/auditevent.html)** A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
- [Get history of AuditEvent with identifier {identifier}](https://api-reference.oystehr.com/reference/get_auditevent-identifier-history.md): **[AuditEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/auditevent.html)** A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
- [Get AuditEvent with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_auditevent-identifier-history-versionidentifier.md): **[AuditEvent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/auditevent.html)** A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
- [Search Basics](https://api-reference.oystehr.com/reference/get_basic.md): **[Basic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/basic.html)** Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
- [Create a new Basic](https://api-reference.oystehr.com/reference/post_basic.md): **[Basic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/basic.html)** Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification. The body should be a valid FHIR object for Basic. Here is an example: ```json { "resourceType": "Basic", "id": "classModel", "text": { "status": "generated", "div": "\n
Class1
\n
\n - Attribute1: 1..*
\n - Attribute2: 0..1
\n
\n
\n
Class1
\n
\n - Attribute1: 1..*
\n - Attribute2: 0..1
\n
\n
[Put rendering here]
" } } ``` You can reference the FHIR documentation to determine the format for [`BiologicallyDerivedProduct`](https://www.hl7.org/fhir/r4b/BiologicallyDerivedProduct.html).
- [Search BiologicallyDerivedProducts](https://api-reference.oystehr.com/reference/post_biologicallyderivedproduct-search.md): **[BiologicallyDerivedProduct on the FHIR specification website.](https://www.hl7.org/fhir/r4b/biologicallyderivedproduct.html)** A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
- [Get BiologicallyDerivedProduct with identifier {identifier}](https://api-reference.oystehr.com/reference/get_biologicallyderivedproduct-identifier.md): **[BiologicallyDerivedProduct on the FHIR specification website.](https://www.hl7.org/fhir/r4b/biologicallyderivedproduct.html)** A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
- [Update BiologicallyDerivedProduct with identifier {identifier}](https://api-reference.oystehr.com/reference/put_biologicallyderivedproduct-identifier.md): **[BiologicallyDerivedProduct on the FHIR specification website.](https://www.hl7.org/fhir/r4b/biologicallyderivedproduct.html)** A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity. The body should be a valid FHIR object for BiologicallyDerivedProduct. Here is an example: ```json { "resourceType": "BiologicallyDerivedProduct", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" } } ``` You can reference the FHIR documentation to determine the format for [`BiologicallyDerivedProduct`](https://www.hl7.org/fhir/r4b/BiologicallyDerivedProduct.html).
- [Patch BiologicallyDerivedProduct with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_biologicallyderivedproduct-identifier.md): **[BiologicallyDerivedProduct on the FHIR specification website.](https://www.hl7.org/fhir/r4b/biologicallyderivedproduct.html)** A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity. The body should be a list of valid JSON patches for BiologicallyDerivedProduct. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete BiologicallyDerivedProduct with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_biologicallyderivedproduct-identifier.md): **[BiologicallyDerivedProduct on the FHIR specification website.](https://www.hl7.org/fhir/r4b/biologicallyderivedproduct.html)** A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
- [Get history of BiologicallyDerivedProduct with identifier {identifier}](https://api-reference.oystehr.com/reference/get_biologicallyderivedproduct-identifier-history.md): **[BiologicallyDerivedProduct on the FHIR specification website.](https://www.hl7.org/fhir/r4b/biologicallyderivedproduct.html)** A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
- [Get BiologicallyDerivedProduct with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_biologicallyderivedproduct-identifier-history-versionidentifier.md): **[BiologicallyDerivedProduct on the FHIR specification website.](https://www.hl7.org/fhir/r4b/biologicallyderivedproduct.html)** A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
- [Search BodyStructures](https://api-reference.oystehr.com/reference/get_bodystructure.md): **[BodyStructure on the FHIR specification website.](https://www.hl7.org/fhir/r4b/bodystructure.html)** Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.
- [Create a new BodyStructure](https://api-reference.oystehr.com/reference/post_bodystructure.md): **[BodyStructure on the FHIR specification website.](https://www.hl7.org/fhir/r4b/bodystructure.html)** Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case. The body should be a valid FHIR object for BodyStructure. Here is an example: ```json { "resourceType": "BodyStructure", "id": "fetus", "text": { "status": "generated", "div": "Generated Narrative with Details
id: fetus
identifier: 12345
location: Fetus (Details : {SNOMED CT code '83418008' = 'Fetus', given as 'Entire fetus (body structure)'})
description: EDD 1/1/2017 confirmation by LMP
patient: Patient/example
Generated Narrative with Details
id: fetus
identifier: 12345
location: Fetus (Details : {SNOMED CT code '83418008' = 'Fetus', given as 'Entire fetus (body structure)'})
description: EDD 1/1/2017 confirmation by LMP
patient: Patient/example
USS Enterprise
" }, "status": "active", "name": "USSS Enterprise-D", "mode": "instance" } }, { "fullUrl": "http://hl7.org/fhir/Location/3", "resource": { "resourceType": "Location", "id": "3", "text": { "status": "generated", "div": "USSS Enterprise-D Sickbay
" }, "status": "active", "name": "USSS Enterprise-D Sickbay", "mode": "instance", "partOf": { "reference": "Location/2", "display": "USS Enterprise" } } } ] } ``` You can reference the FHIR documentation to determine the format for [`Bundle`](https://www.hl7.org/fhir/r4b/Bundle.html).
- [Search Bundles](https://api-reference.oystehr.com/reference/post_bundle-search.md): **[Bundle on the FHIR specification website.](https://www.hl7.org/fhir/r4b/bundle.html)** A container for a collection of resources.
- [Get Bundle with identifier {identifier}](https://api-reference.oystehr.com/reference/get_bundle-identifier.md): **[Bundle on the FHIR specification website.](https://www.hl7.org/fhir/r4b/bundle.html)** A container for a collection of resources.
- [Update Bundle with identifier {identifier}](https://api-reference.oystehr.com/reference/put_bundle-identifier.md): **[Bundle on the FHIR specification website.](https://www.hl7.org/fhir/r4b/bundle.html)** A container for a collection of resources. The body should be a valid FHIR object for Bundle. Here is an example: ```json { "resourceType": "Bundle", "id": "3ad0687e-f477-468c-afd5-fcc2bf897819", "type": "collection", "entry": [ { "fullUrl": "http://hl7.org/fhir/Location/2", "resource": { "resourceType": "Location", "id": "2", "text": { "status": "generated", "div": "USS Enterprise
" }, "status": "active", "name": "USSS Enterprise-D", "mode": "instance" } }, { "fullUrl": "http://hl7.org/fhir/Location/3", "resource": { "resourceType": "Location", "id": "3", "text": { "status": "generated", "div": "USSS Enterprise-D Sickbay
" }, "status": "active", "name": "USSS Enterprise-D Sickbay", "mode": "instance", "partOf": { "reference": "Location/2", "display": "USS Enterprise" } } } ] } ``` You can reference the FHIR documentation to determine the format for [`Bundle`](https://www.hl7.org/fhir/r4b/Bundle.html).
- [Patch Bundle with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_bundle-identifier.md): **[Bundle on the FHIR specification website.](https://www.hl7.org/fhir/r4b/bundle.html)** A container for a collection of resources. The body should be a list of valid JSON patches for Bundle. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Bundle with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_bundle-identifier.md): **[Bundle on the FHIR specification website.](https://www.hl7.org/fhir/r4b/bundle.html)** A container for a collection of resources.
- [Get history of Bundle with identifier {identifier}](https://api-reference.oystehr.com/reference/get_bundle-identifier-history.md): **[Bundle on the FHIR specification website.](https://www.hl7.org/fhir/r4b/bundle.html)** A container for a collection of resources.
- [Get Bundle with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_bundle-identifier-history-versionidentifier.md): **[Bundle on the FHIR specification website.](https://www.hl7.org/fhir/r4b/bundle.html)** A container for a collection of resources.
- [Search CapabilityStatements](https://api-reference.oystehr.com/reference/get_capabilitystatement.md): **[CapabilityStatement on the FHIR specification website.](https://www.hl7.org/fhir/r4b/capabilitystatement.html)** A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
- [Create a new CapabilityStatement](https://api-reference.oystehr.com/reference/post_capabilitystatement.md): **[CapabilityStatement on the FHIR specification website.](https://www.hl7.org/fhir/r4b/capabilitystatement.html)** A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation. The body should be a valid FHIR object for CapabilityStatement. Here is an example: ```json { "resourceType": "CapabilityStatement", "id": "messagedefinition", "text": { "status": "generated", "div": "\n
\n
\n
Sample capability statement showing new MessageDefinition structure
\n\n
\n
\n
\n
\n
Sample capability statement showing new MessageDefinition structure
\n\n
\n
\n
Care plan to address obesity. Goal is a target weight of 160 to 180 lbs. Activities include diet and exercise.
\n
\n
Care plan to address obesity. Goal is a target weight of 160 to 180 lbs. Activities include diet and exercise.
\n
Care Team
" }, "contained": [ { "resourceType": "Practitioner", "id": "pr1", "name": [ { "family": "Dietician", "given": [ "Dorothy" ] } ] } ], "identifier": [ { "value": "12345" } ], "status": "active", "category": [ { "coding": [ { "system": "http://loinc.org", "code": "LA27976-2", "display": "Encounter-focused care team" } ] } ], "name": "Peter James Charlmers Care Plan for Inpatient Encounter", "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "encounter": { "reference": "Encounter/example" }, "period": { "end": "2013-01-01" }, "participant": [ { "role": [ { "text": "responsiblePerson" } ], "member": { "reference": "Patient/example", "display": "Peter James Chalmers" } }, { "role": [ { "text": "adviser" } ], "member": { "reference": "#pr1", "display": "Dorothy Dietition" }, "onBehalfOf": { "reference": "Organization/f001" }, "period": { "end": "2013-01-01" } } ], "managingOrganization": [ { "reference": "Organization/f001" } ] } ``` You can reference the FHIR documentation to determine the format for [`CareTeam`](https://www.hl7.org/fhir/r4b/CareTeam.html).
- [Search CareTeams](https://api-reference.oystehr.com/reference/post_careteam-search.md): **[CareTeam on the FHIR specification website.](https://www.hl7.org/fhir/r4b/careteam.html)** The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
- [Get CareTeam with identifier {identifier}](https://api-reference.oystehr.com/reference/get_careteam-identifier.md): **[CareTeam on the FHIR specification website.](https://www.hl7.org/fhir/r4b/careteam.html)** The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
- [Update CareTeam with identifier {identifier}](https://api-reference.oystehr.com/reference/put_careteam-identifier.md): **[CareTeam on the FHIR specification website.](https://www.hl7.org/fhir/r4b/careteam.html)** The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient. The body should be a valid FHIR object for CareTeam. Here is an example: ```json { "resourceType": "CareTeam", "id": "example", "text": { "status": "generated", "div": "Care Team
" }, "contained": [ { "resourceType": "Practitioner", "id": "pr1", "name": [ { "family": "Dietician", "given": [ "Dorothy" ] } ] } ], "identifier": [ { "value": "12345" } ], "status": "active", "category": [ { "coding": [ { "system": "http://loinc.org", "code": "LA27976-2", "display": "Encounter-focused care team" } ] } ], "name": "Peter James Charlmers Care Plan for Inpatient Encounter", "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "encounter": { "reference": "Encounter/example" }, "period": { "end": "2013-01-01" }, "participant": [ { "role": [ { "text": "responsiblePerson" } ], "member": { "reference": "Patient/example", "display": "Peter James Chalmers" } }, { "role": [ { "text": "adviser" } ], "member": { "reference": "#pr1", "display": "Dorothy Dietition" }, "onBehalfOf": { "reference": "Organization/f001" }, "period": { "end": "2013-01-01" } } ], "managingOrganization": [ { "reference": "Organization/f001" } ] } ``` You can reference the FHIR documentation to determine the format for [`CareTeam`](https://www.hl7.org/fhir/r4b/CareTeam.html).
- [Patch CareTeam with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_careteam-identifier.md): **[CareTeam on the FHIR specification website.](https://www.hl7.org/fhir/r4b/careteam.html)** The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient. The body should be a list of valid JSON patches for CareTeam. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete CareTeam with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_careteam-identifier.md): **[CareTeam on the FHIR specification website.](https://www.hl7.org/fhir/r4b/careteam.html)** The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
- [Get history of CareTeam with identifier {identifier}](https://api-reference.oystehr.com/reference/get_careteam-identifier-history.md): **[CareTeam on the FHIR specification website.](https://www.hl7.org/fhir/r4b/careteam.html)** The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
- [Get CareTeam with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_careteam-identifier-history-versionidentifier.md): **[CareTeam on the FHIR specification website.](https://www.hl7.org/fhir/r4b/careteam.html)** The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
- [Search CatalogEntrys](https://api-reference.oystehr.com/reference/get_catalogentry.md): **[CatalogEntry on the FHIR specification website.](https://www.hl7.org/fhir/r4b/catalogentry.html)** Catalog entries are wrappers that contextualize items included in a catalog.
- [Create a new CatalogEntry](https://api-reference.oystehr.com/reference/post_catalogentry.md): **[CatalogEntry on the FHIR specification website.](https://www.hl7.org/fhir/r4b/catalogentry.html)** Catalog entries are wrappers that contextualize items included in a catalog. The body should be a valid FHIR object for CatalogEntry. Here is an example: ```json { "resourceType": "CatalogEntry", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "identifier": [ { "system": "http://example.com/identifier", "value": "123" } ], "type": { "text": "Medication" }, "orderable": true, "referencedItem": { "reference": "Medication/123" } } ``` You can reference the FHIR documentation to determine the format for [`CatalogEntry`](https://www.hl7.org/fhir/r4b/CatalogEntry.html).
- [Search CatalogEntrys](https://api-reference.oystehr.com/reference/post_catalogentry-search.md): **[CatalogEntry on the FHIR specification website.](https://www.hl7.org/fhir/r4b/catalogentry.html)** Catalog entries are wrappers that contextualize items included in a catalog.
- [Get CatalogEntry with identifier {identifier}](https://api-reference.oystehr.com/reference/get_catalogentry-identifier.md): **[CatalogEntry on the FHIR specification website.](https://www.hl7.org/fhir/r4b/catalogentry.html)** Catalog entries are wrappers that contextualize items included in a catalog.
- [Update CatalogEntry with identifier {identifier}](https://api-reference.oystehr.com/reference/put_catalogentry-identifier.md): **[CatalogEntry on the FHIR specification website.](https://www.hl7.org/fhir/r4b/catalogentry.html)** Catalog entries are wrappers that contextualize items included in a catalog. The body should be a valid FHIR object for CatalogEntry. Here is an example: ```json { "resourceType": "CatalogEntry", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "identifier": [ { "system": "http://example.com/identifier", "value": "123" } ], "type": { "text": "Medication" }, "orderable": true, "referencedItem": { "reference": "Medication/123" } } ``` You can reference the FHIR documentation to determine the format for [`CatalogEntry`](https://www.hl7.org/fhir/r4b/CatalogEntry.html).
- [Patch CatalogEntry with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_catalogentry-identifier.md): **[CatalogEntry on the FHIR specification website.](https://www.hl7.org/fhir/r4b/catalogentry.html)** Catalog entries are wrappers that contextualize items included in a catalog. The body should be a list of valid JSON patches for CatalogEntry. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete CatalogEntry with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_catalogentry-identifier.md): **[CatalogEntry on the FHIR specification website.](https://www.hl7.org/fhir/r4b/catalogentry.html)** Catalog entries are wrappers that contextualize items included in a catalog.
- [Get history of CatalogEntry with identifier {identifier}](https://api-reference.oystehr.com/reference/get_catalogentry-identifier-history.md): **[CatalogEntry on the FHIR specification website.](https://www.hl7.org/fhir/r4b/catalogentry.html)** Catalog entries are wrappers that contextualize items included in a catalog.
- [Get CatalogEntry with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_catalogentry-identifier-history-versionidentifier.md): **[CatalogEntry on the FHIR specification website.](https://www.hl7.org/fhir/r4b/catalogentry.html)** Catalog entries are wrappers that contextualize items included in a catalog.
- [Search ChargeItems](https://api-reference.oystehr.com/reference/get_chargeitem.md): **[ChargeItem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitem.html)** The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
- [Create a new ChargeItem](https://api-reference.oystehr.com/reference/post_chargeitem.md): **[ChargeItem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitem.html)** The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation. The body should be a valid FHIR object for ChargeItem. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ChargeItem`](https://www.hl7.org/fhir/r4b/ChargeItem.html).
- [Search ChargeItems](https://api-reference.oystehr.com/reference/post_chargeitem-search.md): **[ChargeItem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitem.html)** The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
- [Get ChargeItem with identifier {identifier}](https://api-reference.oystehr.com/reference/get_chargeitem-identifier.md): **[ChargeItem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitem.html)** The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
- [Update ChargeItem with identifier {identifier}](https://api-reference.oystehr.com/reference/put_chargeitem-identifier.md): **[ChargeItem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitem.html)** The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation. The body should be a valid FHIR object for ChargeItem. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ChargeItem`](https://www.hl7.org/fhir/r4b/ChargeItem.html).
- [Patch ChargeItem with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_chargeitem-identifier.md): **[ChargeItem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitem.html)** The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation. The body should be a list of valid JSON patches for ChargeItem. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ChargeItem with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_chargeitem-identifier.md): **[ChargeItem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitem.html)** The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
- [Get history of ChargeItem with identifier {identifier}](https://api-reference.oystehr.com/reference/get_chargeitem-identifier-history.md): **[ChargeItem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitem.html)** The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
- [Get ChargeItem with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_chargeitem-identifier-history-versionidentifier.md): **[ChargeItem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitem.html)** The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
- [Search ChargeItemDefinitions](https://api-reference.oystehr.com/reference/get_chargeitemdefinition.md): **[ChargeItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitemdefinition.html)** The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.
- [Create a new ChargeItemDefinition](https://api-reference.oystehr.com/reference/post_chargeitemdefinition.md): **[ChargeItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitemdefinition.html)** The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system. The body should be a valid FHIR object for ChargeItemDefinition. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ChargeItemDefinition`](https://www.hl7.org/fhir/r4b/ChargeItemDefinition.html).
- [Search ChargeItemDefinitions](https://api-reference.oystehr.com/reference/post_chargeitemdefinition-search.md): **[ChargeItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitemdefinition.html)** The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.
- [Get ChargeItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_chargeitemdefinition-identifier.md): **[ChargeItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitemdefinition.html)** The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.
- [Update ChargeItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_chargeitemdefinition-identifier.md): **[ChargeItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitemdefinition.html)** The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system. The body should be a valid FHIR object for ChargeItemDefinition. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ChargeItemDefinition`](https://www.hl7.org/fhir/r4b/ChargeItemDefinition.html).
- [Patch ChargeItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_chargeitemdefinition-identifier.md): **[ChargeItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitemdefinition.html)** The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system. The body should be a list of valid JSON patches for ChargeItemDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ChargeItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_chargeitemdefinition-identifier.md): **[ChargeItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitemdefinition.html)** The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.
- [Get history of ChargeItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_chargeitemdefinition-identifier-history.md): **[ChargeItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitemdefinition.html)** The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.
- [Get ChargeItemDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_chargeitemdefinition-identifier-history-versionidentifier.md): **[ChargeItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/chargeitemdefinition.html)** The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.
- [Search Citations](https://api-reference.oystehr.com/reference/get_citation.md): **[Citation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/citation.html)** The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
- [Create a new Citation](https://api-reference.oystehr.com/reference/post_citation.md): **[Citation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/citation.html)** The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources. The body should be a valid FHIR object for Citation. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`Citation`](https://www.hl7.org/fhir/r4b/Citation.html).
- [Search Citations](https://api-reference.oystehr.com/reference/post_citation-search.md): **[Citation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/citation.html)** The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
- [Get Citation with identifier {identifier}](https://api-reference.oystehr.com/reference/get_citation-identifier.md): **[Citation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/citation.html)** The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
- [Update Citation with identifier {identifier}](https://api-reference.oystehr.com/reference/put_citation-identifier.md): **[Citation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/citation.html)** The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources. The body should be a valid FHIR object for Citation. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`Citation`](https://www.hl7.org/fhir/r4b/Citation.html).
- [Patch Citation with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_citation-identifier.md): **[Citation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/citation.html)** The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources. The body should be a list of valid JSON patches for Citation. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Citation with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_citation-identifier.md): **[Citation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/citation.html)** The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
- [Get history of Citation with identifier {identifier}](https://api-reference.oystehr.com/reference/get_citation-identifier-history.md): **[Citation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/citation.html)** The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
- [Get Citation with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_citation-identifier-history-versionidentifier.md): **[Citation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/citation.html)** The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
- [Search Claims](https://api-reference.oystehr.com/reference/get_claim.md): **[Claim on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claim.html)** A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
- [Create a new Claim](https://api-reference.oystehr.com/reference/post_claim.md): **[Claim on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claim.html)** A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement. The body should be a valid FHIR object for Claim. Here is an example: ```json { "resourceType": "Claim", "id": "100150", "text": { "status": "generated", "div": "A human-readable rendering of the Oral Health Claim
" }, "identifier": [ { "system": "http://happyvalley.com/claim", "value": "12345" } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "oral" } ] }, "use": "claim", "patient": { "reference": "Patient/1" }, "created": "2014-08-16", "insurer": { "reference": "Organization/2" }, "provider": { "reference": "Organization/1" }, "priority": { "coding": [ { "code": "normal" } ] }, "payee": { "type": { "coding": [ { "code": "provider" } ] } }, "careTeam": [ { "sequence": 1, "provider": { "reference": "Practitioner/example" } } ], "diagnosis": [ { "sequence": 1, "diagnosisCodeableConcept": { "coding": [ { "code": "123456" } ] } } ], "insurance": [ { "sequence": 1, "focal": true, "identifier": { "system": "http://happyvalley.com/claim", "value": "12345" }, "coverage": { "reference": "Coverage/9876B1" } } ], "item": [ { "sequence": 1, "careTeamSequence": [ 1 ], "productOrService": { "coding": [ { "code": "1200" } ] }, "servicedDate": "2014-08-16", "unitPrice": { "value": 135.57, "currency": "USD" }, "net": { "value": 135.57, "currency": "USD" } } ] } ``` You can reference the FHIR documentation to determine the format for [`Claim`](https://www.hl7.org/fhir/r4b/Claim.html).
- [Search Claims](https://api-reference.oystehr.com/reference/post_claim-search.md): **[Claim on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claim.html)** A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
- [Get Claim with identifier {identifier}](https://api-reference.oystehr.com/reference/get_claim-identifier.md): **[Claim on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claim.html)** A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
- [Update Claim with identifier {identifier}](https://api-reference.oystehr.com/reference/put_claim-identifier.md): **[Claim on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claim.html)** A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement. The body should be a valid FHIR object for Claim. Here is an example: ```json { "resourceType": "Claim", "id": "100150", "text": { "status": "generated", "div": "A human-readable rendering of the Oral Health Claim
" }, "identifier": [ { "system": "http://happyvalley.com/claim", "value": "12345" } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "oral" } ] }, "use": "claim", "patient": { "reference": "Patient/1" }, "created": "2014-08-16", "insurer": { "reference": "Organization/2" }, "provider": { "reference": "Organization/1" }, "priority": { "coding": [ { "code": "normal" } ] }, "payee": { "type": { "coding": [ { "code": "provider" } ] } }, "careTeam": [ { "sequence": 1, "provider": { "reference": "Practitioner/example" } } ], "diagnosis": [ { "sequence": 1, "diagnosisCodeableConcept": { "coding": [ { "code": "123456" } ] } } ], "insurance": [ { "sequence": 1, "focal": true, "identifier": { "system": "http://happyvalley.com/claim", "value": "12345" }, "coverage": { "reference": "Coverage/9876B1" } } ], "item": [ { "sequence": 1, "careTeamSequence": [ 1 ], "productOrService": { "coding": [ { "code": "1200" } ] }, "servicedDate": "2014-08-16", "unitPrice": { "value": 135.57, "currency": "USD" }, "net": { "value": 135.57, "currency": "USD" } } ] } ``` You can reference the FHIR documentation to determine the format for [`Claim`](https://www.hl7.org/fhir/r4b/Claim.html).
- [Patch Claim with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_claim-identifier.md): **[Claim on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claim.html)** A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement. The body should be a list of valid JSON patches for Claim. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Claim with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_claim-identifier.md): **[Claim on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claim.html)** A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
- [Get history of Claim with identifier {identifier}](https://api-reference.oystehr.com/reference/get_claim-identifier-history.md): **[Claim on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claim.html)** A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
- [Get Claim with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_claim-identifier-history-versionidentifier.md): **[Claim on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claim.html)** A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
- [Search ClaimResponses](https://api-reference.oystehr.com/reference/get_claimresponse.md): **[ClaimResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claimresponse.html)** This resource provides the adjudication details from the processing of a Claim resource.
- [Create a new ClaimResponse](https://api-reference.oystehr.com/reference/post_claimresponse.md): **[ClaimResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claimresponse.html)** This resource provides the adjudication details from the processing of a Claim resource. The body should be a valid FHIR object for ClaimResponse. Here is an example: ```json { "resourceType": "ClaimResponse", "id": "R3501", "text": { "status": "generated", "div": "A human-readable rendering of the ClaimResponse that demonstrates returning errors
" }, "identifier": [ { "system": "http://www.BenefitsInc.com/fhir/remittance", "value": "R3501" } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "oral" } ] }, "use": "claim", "patient": { "reference": "Patient/1" }, "created": "2014-08-16", "insurer": { "identifier": { "system": "http://www.jurisdiction.org/insurers", "value": "555123" } }, "requestor": { "reference": "Practitioner/1" }, "request": { "reference": "Claim/100156" }, "outcome": "error", "disposition": "Claim could not be processed", "formCode": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/forms-codes", "code": "2" } ] }, "processNote": [ { "number": 1, "type": "display", "text": "Invalid claim", "language": { "coding": [ { "system": "urn:ietf:bcp:47", "code": "en-CA" } ] } } ], "communicationRequest": [ { "reference": "CommunicationRequest/fm-solicit" } ], "error": [ { "itemSequence": 3, "detailSequence": 2, "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/adjudication-error", "code": "a002" } ] } } ] } ``` You can reference the FHIR documentation to determine the format for [`ClaimResponse`](https://www.hl7.org/fhir/r4b/ClaimResponse.html).
- [Search ClaimResponses](https://api-reference.oystehr.com/reference/post_claimresponse-search.md): **[ClaimResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claimresponse.html)** This resource provides the adjudication details from the processing of a Claim resource.
- [Get ClaimResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/get_claimresponse-identifier.md): **[ClaimResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claimresponse.html)** This resource provides the adjudication details from the processing of a Claim resource.
- [Update ClaimResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/put_claimresponse-identifier.md): **[ClaimResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claimresponse.html)** This resource provides the adjudication details from the processing of a Claim resource. The body should be a valid FHIR object for ClaimResponse. Here is an example: ```json { "resourceType": "ClaimResponse", "id": "R3501", "text": { "status": "generated", "div": "A human-readable rendering of the ClaimResponse that demonstrates returning errors
" }, "identifier": [ { "system": "http://www.BenefitsInc.com/fhir/remittance", "value": "R3501" } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/claim-type", "code": "oral" } ] }, "use": "claim", "patient": { "reference": "Patient/1" }, "created": "2014-08-16", "insurer": { "identifier": { "system": "http://www.jurisdiction.org/insurers", "value": "555123" } }, "requestor": { "reference": "Practitioner/1" }, "request": { "reference": "Claim/100156" }, "outcome": "error", "disposition": "Claim could not be processed", "formCode": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/forms-codes", "code": "2" } ] }, "processNote": [ { "number": 1, "type": "display", "text": "Invalid claim", "language": { "coding": [ { "system": "urn:ietf:bcp:47", "code": "en-CA" } ] } } ], "communicationRequest": [ { "reference": "CommunicationRequest/fm-solicit" } ], "error": [ { "itemSequence": 3, "detailSequence": 2, "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/adjudication-error", "code": "a002" } ] } } ] } ``` You can reference the FHIR documentation to determine the format for [`ClaimResponse`](https://www.hl7.org/fhir/r4b/ClaimResponse.html).
- [Patch ClaimResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_claimresponse-identifier.md): **[ClaimResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claimresponse.html)** This resource provides the adjudication details from the processing of a Claim resource. The body should be a list of valid JSON patches for ClaimResponse. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ClaimResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_claimresponse-identifier.md): **[ClaimResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claimresponse.html)** This resource provides the adjudication details from the processing of a Claim resource.
- [Get history of ClaimResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/get_claimresponse-identifier-history.md): **[ClaimResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claimresponse.html)** This resource provides the adjudication details from the processing of a Claim resource.
- [Get ClaimResponse with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_claimresponse-identifier-history-versionidentifier.md): **[ClaimResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/claimresponse.html)** This resource provides the adjudication details from the processing of a Claim resource.
- [Search ClinicalImpressions](https://api-reference.oystehr.com/reference/get_clinicalimpression.md): **[ClinicalImpression on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalimpression.html)** A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
- [Create a new ClinicalImpression](https://api-reference.oystehr.com/reference/post_clinicalimpression.md): **[ClinicalImpression on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalimpression.html)** A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score. The body should be a valid FHIR object for ClinicalImpression. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ClinicalImpression`](https://www.hl7.org/fhir/r4b/ClinicalImpression.html).
- [Search ClinicalImpressions](https://api-reference.oystehr.com/reference/post_clinicalimpression-search.md): **[ClinicalImpression on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalimpression.html)** A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
- [Get ClinicalImpression with identifier {identifier}](https://api-reference.oystehr.com/reference/get_clinicalimpression-identifier.md): **[ClinicalImpression on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalimpression.html)** A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
- [Update ClinicalImpression with identifier {identifier}](https://api-reference.oystehr.com/reference/put_clinicalimpression-identifier.md): **[ClinicalImpression on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalimpression.html)** A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score. The body should be a valid FHIR object for ClinicalImpression. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ClinicalImpression`](https://www.hl7.org/fhir/r4b/ClinicalImpression.html).
- [Patch ClinicalImpression with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_clinicalimpression-identifier.md): **[ClinicalImpression on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalimpression.html)** A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score. The body should be a list of valid JSON patches for ClinicalImpression. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ClinicalImpression with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_clinicalimpression-identifier.md): **[ClinicalImpression on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalimpression.html)** A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
- [Get history of ClinicalImpression with identifier {identifier}](https://api-reference.oystehr.com/reference/get_clinicalimpression-identifier-history.md): **[ClinicalImpression on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalimpression.html)** A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
- [Get ClinicalImpression with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_clinicalimpression-identifier-history-versionidentifier.md): **[ClinicalImpression on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalimpression.html)** A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
- [Search ClinicalUseDefinitions](https://api-reference.oystehr.com/reference/get_clinicalusedefinition.md): **[ClinicalUseDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalusedefinition.html)** A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.
- [Create a new ClinicalUseDefinition](https://api-reference.oystehr.com/reference/post_clinicalusedefinition.md): **[ClinicalUseDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalusedefinition.html)** A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure. The body should be a valid FHIR object for ClinicalUseDefinition. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ClinicalUseDefinition`](https://www.hl7.org/fhir/r4b/ClinicalUseDefinition.html).
- [Search ClinicalUseDefinitions](https://api-reference.oystehr.com/reference/post_clinicalusedefinition-search.md): **[ClinicalUseDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalusedefinition.html)** A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.
- [Get ClinicalUseDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_clinicalusedefinition-identifier.md): **[ClinicalUseDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalusedefinition.html)** A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.
- [Update ClinicalUseDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_clinicalusedefinition-identifier.md): **[ClinicalUseDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalusedefinition.html)** A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure. The body should be a valid FHIR object for ClinicalUseDefinition. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ClinicalUseDefinition`](https://www.hl7.org/fhir/r4b/ClinicalUseDefinition.html).
- [Patch ClinicalUseDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_clinicalusedefinition-identifier.md): **[ClinicalUseDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalusedefinition.html)** A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure. The body should be a list of valid JSON patches for ClinicalUseDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ClinicalUseDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_clinicalusedefinition-identifier.md): **[ClinicalUseDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalusedefinition.html)** A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.
- [Get history of ClinicalUseDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_clinicalusedefinition-identifier-history.md): **[ClinicalUseDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalusedefinition.html)** A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.
- [Get ClinicalUseDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_clinicalusedefinition-identifier-history-versionidentifier.md): **[ClinicalUseDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/clinicalusedefinition.html)** A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.
- [Search CodeSystems](https://api-reference.oystehr.com/reference/get_codesystem.md): **[CodeSystem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/codesystem.html)** The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.
- [Create a new CodeSystem](https://api-reference.oystehr.com/reference/post_codesystem.md): **[CodeSystem on the FHIR specification website.](https://www.hl7.org/fhir/r4b/codesystem.html)** The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content. The body should be a valid FHIR object for CodeSystem. Here is an example: ```json { "resourceType": "CodeSystem", "id": "catalogType", "meta": { "lastUpdated": "2019-11-01T09:29:23.356+11:00" }, "text": { "status": "generated", "div": "\n
CatalogType
\n
\n
The type of catalog.
\n\n
\n
This code system http://terminology.hl7.org/CodeSystem/catalogType defines the following codes:
\n
\n \n | \n Code\n | \n \n Display\n | \n \n Definition\n | \n
\n \n | medication\n \n | \n Medication Catalog | \n Medication Catalog. | \n
\n \n | device\n \n | \n Device Catalog | \n Device Catalog. | \n
\n \n | protocol\n \n | \n Protocol List | \n Protocol List. | \n
\n
\n
\n
CatalogType
\n
\n
The type of catalog.
\n\n
\n
This code system http://terminology.hl7.org/CodeSystem/catalogType defines the following codes:
\n
\n \n | \n Code\n | \n \n Display\n | \n \n Definition\n | \n
\n \n | medication\n \n | \n Medication Catalog | \n Medication Catalog. | \n
\n \n | device\n \n | \n Device Catalog | \n Device Catalog. | \n
\n \n | protocol\n \n | \n Protocol List | \n Protocol List. | \n
\n
\n
Patient has very high serum potassium
" }, "identifier": [ { "type": { "text": "Paging System" }, "system": "urn:oid:1.3.4.5.6.7", "value": "2345678901" } ], "instantiatesUri": [ "http://example.org/hyperkalemia" ], "partOf": [ { "display": "Serum Potassium Observation" } ], "status": "completed", "category": [ { "coding": [ { "system": "http://acme.org/messagetypes", "code": "Alert" } ], "text": "Alert" } ], "medium": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode", "code": "WRITTEN", "display": "written" } ], "text": "written" } ], "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" }, "sent": "2014-12-12T18:01:10-08:00", "received": "2014-12-12T18:01:11-08:00", "recipient": [ { "reference": "Practitioner/example" } ], "sender": { "reference": "Device/f001" }, "payload": [ { "contentString": "Patient 1 has a very high serum potassium value (7.2 mmol/L on 2014-Dec-12 at 5:55 pm)" }, { "contentReference": { "display": "Serum Potassium Observation" } } ] } ``` You can reference the FHIR documentation to determine the format for [`Communication`](https://www.hl7.org/fhir/r4b/Communication.html).
- [Search Communications](https://api-reference.oystehr.com/reference/post_communication-search.md): **[Communication on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communication.html)** An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.
- [Get Communication with identifier {identifier}](https://api-reference.oystehr.com/reference/get_communication-identifier.md): **[Communication on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communication.html)** An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.
- [Update Communication with identifier {identifier}](https://api-reference.oystehr.com/reference/put_communication-identifier.md): **[Communication on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communication.html)** An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition. The body should be a valid FHIR object for Communication. Here is an example: ```json { "resourceType": "Communication", "id": "example", "text": { "status": "generated", "div": "Patient has very high serum potassium
" }, "identifier": [ { "type": { "text": "Paging System" }, "system": "urn:oid:1.3.4.5.6.7", "value": "2345678901" } ], "instantiatesUri": [ "http://example.org/hyperkalemia" ], "partOf": [ { "display": "Serum Potassium Observation" } ], "status": "completed", "category": [ { "coding": [ { "system": "http://acme.org/messagetypes", "code": "Alert" } ], "text": "Alert" } ], "medium": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode", "code": "WRITTEN", "display": "written" } ], "text": "written" } ], "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" }, "sent": "2014-12-12T18:01:10-08:00", "received": "2014-12-12T18:01:11-08:00", "recipient": [ { "reference": "Practitioner/example" } ], "sender": { "reference": "Device/f001" }, "payload": [ { "contentString": "Patient 1 has a very high serum potassium value (7.2 mmol/L on 2014-Dec-12 at 5:55 pm)" }, { "contentReference": { "display": "Serum Potassium Observation" } } ] } ``` You can reference the FHIR documentation to determine the format for [`Communication`](https://www.hl7.org/fhir/r4b/Communication.html).
- [Patch Communication with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_communication-identifier.md): **[Communication on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communication.html)** An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition. The body should be a list of valid JSON patches for Communication. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Communication with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_communication-identifier.md): **[Communication on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communication.html)** An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.
- [Get history of Communication with identifier {identifier}](https://api-reference.oystehr.com/reference/get_communication-identifier-history.md): **[Communication on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communication.html)** An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.
- [Get Communication with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_communication-identifier-history-versionidentifier.md): **[Communication on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communication.html)** An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.
- [Search CommunicationRequests](https://api-reference.oystehr.com/reference/get_communicationrequest.md): **[CommunicationRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communicationrequest.html)** A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
- [Create a new CommunicationRequest](https://api-reference.oystehr.com/reference/post_communicationrequest.md): **[CommunicationRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communicationrequest.html)** A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. The body should be a valid FHIR object for CommunicationRequest. Here is an example: ```json { "resourceType": "CommunicationRequest", "id": "example", "text": { "status": "generated", "div": "To be filled out at a later time
" }, "status": "active", "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" } } ``` You can reference the FHIR documentation to determine the format for [`CommunicationRequest`](https://www.hl7.org/fhir/r4b/CommunicationRequest.html).
- [Search CommunicationRequests](https://api-reference.oystehr.com/reference/post_communicationrequest-search.md): **[CommunicationRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communicationrequest.html)** A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
- [Get CommunicationRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/get_communicationrequest-identifier.md): **[CommunicationRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communicationrequest.html)** A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
- [Update CommunicationRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/put_communicationrequest-identifier.md): **[CommunicationRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communicationrequest.html)** A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. The body should be a valid FHIR object for CommunicationRequest. Here is an example: ```json { "resourceType": "CommunicationRequest", "id": "example", "text": { "status": "generated", "div": "To be filled out at a later time
" }, "status": "active", "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" } } ``` You can reference the FHIR documentation to determine the format for [`CommunicationRequest`](https://www.hl7.org/fhir/r4b/CommunicationRequest.html).
- [Patch CommunicationRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_communicationrequest-identifier.md): **[CommunicationRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communicationrequest.html)** A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. The body should be a list of valid JSON patches for CommunicationRequest. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete CommunicationRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_communicationrequest-identifier.md): **[CommunicationRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communicationrequest.html)** A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
- [Get history of CommunicationRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/get_communicationrequest-identifier-history.md): **[CommunicationRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communicationrequest.html)** A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
- [Get CommunicationRequest with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_communicationrequest-identifier-history-versionidentifier.md): **[CommunicationRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/communicationrequest.html)** A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
- [Search CompartmentDefinitions](https://api-reference.oystehr.com/reference/get_compartmentdefinition.md): **[CompartmentDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/compartmentdefinition.html)** A compartment definition that defines how resources are accessed on a server.
- [Create a new CompartmentDefinition](https://api-reference.oystehr.com/reference/post_compartmentdefinition.md): **[CompartmentDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/compartmentdefinition.html)** A compartment definition that defines how resources are accessed on a server. The body should be a valid FHIR object for CompartmentDefinition. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`CompartmentDefinition`](https://www.hl7.org/fhir/r4b/CompartmentDefinition.html).
- [Search CompartmentDefinitions](https://api-reference.oystehr.com/reference/post_compartmentdefinition-search.md): **[CompartmentDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/compartmentdefinition.html)** A compartment definition that defines how resources are accessed on a server.
- [Get CompartmentDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_compartmentdefinition-identifier.md): **[CompartmentDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/compartmentdefinition.html)** A compartment definition that defines how resources are accessed on a server.
- [Update CompartmentDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_compartmentdefinition-identifier.md): **[CompartmentDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/compartmentdefinition.html)** A compartment definition that defines how resources are accessed on a server. The body should be a valid FHIR object for CompartmentDefinition. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`CompartmentDefinition`](https://www.hl7.org/fhir/r4b/CompartmentDefinition.html).
- [Patch CompartmentDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_compartmentdefinition-identifier.md): **[CompartmentDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/compartmentdefinition.html)** A compartment definition that defines how resources are accessed on a server. The body should be a list of valid JSON patches for CompartmentDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete CompartmentDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_compartmentdefinition-identifier.md): **[CompartmentDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/compartmentdefinition.html)** A compartment definition that defines how resources are accessed on a server.
- [Get history of CompartmentDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_compartmentdefinition-identifier-history.md): **[CompartmentDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/compartmentdefinition.html)** A compartment definition that defines how resources are accessed on a server.
- [Get CompartmentDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_compartmentdefinition-identifier-history-versionidentifier.md): **[CompartmentDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/compartmentdefinition.html)** A compartment definition that defines how resources are accessed on a server.
- [Search Compositions](https://api-reference.oystehr.com/reference/get_composition.md): **[Composition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/composition.html)** A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
- [Create a new Composition](https://api-reference.oystehr.com/reference/post_composition.md): **[Composition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/composition.html)** A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). The body should be a valid FHIR object for Composition. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`Composition`](https://www.hl7.org/fhir/r4b/Composition.html).
- [Search Compositions](https://api-reference.oystehr.com/reference/post_composition-search.md): **[Composition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/composition.html)** A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
- [Get Composition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_composition-identifier.md): **[Composition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/composition.html)** A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
- [Update Composition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_composition-identifier.md): **[Composition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/composition.html)** A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). The body should be a valid FHIR object for Composition. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`Composition`](https://www.hl7.org/fhir/r4b/Composition.html).
- [Patch Composition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_composition-identifier.md): **[Composition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/composition.html)** A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). The body should be a list of valid JSON patches for Composition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Composition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_composition-identifier.md): **[Composition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/composition.html)** A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
- [Get history of Composition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_composition-identifier-history.md): **[Composition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/composition.html)** A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
- [Get Composition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_composition-identifier-history-versionidentifier.md): **[Composition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/composition.html)** A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
- [Search ConceptMaps](https://api-reference.oystehr.com/reference/get_conceptmap.md): **[ConceptMap on the FHIR specification website.](https://www.hl7.org/fhir/r4b/conceptmap.html)** A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.
- [Create a new ConceptMap](https://api-reference.oystehr.com/reference/post_conceptmap.md): **[ConceptMap on the FHIR specification website.](https://www.hl7.org/fhir/r4b/conceptmap.html)** A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models. The body should be a valid FHIR object for ConceptMap. Here is an example: ```json { "resourceType": "ConceptMap", "id": "cm-address-type-v3", "text": { "status": "generated", "div": "" }, "url": "http://hl7.org/fhir/ConceptMap/cm-address-type-v3", "version": "4.0.1", "name": "v3.AddressType", "title": "v3 map for AddressType", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7 (FHIR Project)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" }, { "system": "email", "value": "fhir@lists.hl7.org" } ] } ], "sourceCanonical": "http://hl7.org/fhir/ValueSet/address-type", "targetCanonical": "http://terminology.hl7.org/ValueSet/v3-AddressUse", "group": [ { "source": "http://hl7.org/fhir/address-type", "target": "http://terminology.hl7.org/CodeSystem/v3-AddressUse", "element": [ { "code": "postal", "target": [ { "code": "PST", "equivalence": "equal" } ] }, { "code": "physical", "target": [ { "code": "PHYS", "equivalence": "equal" } ] } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`ConceptMap`](https://www.hl7.org/fhir/r4b/ConceptMap.html).
- [Search ConceptMaps](https://api-reference.oystehr.com/reference/post_conceptmap-search.md): **[ConceptMap on the FHIR specification website.](https://www.hl7.org/fhir/r4b/conceptmap.html)** A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.
- [Get ConceptMap with identifier {identifier}](https://api-reference.oystehr.com/reference/get_conceptmap-identifier.md): **[ConceptMap on the FHIR specification website.](https://www.hl7.org/fhir/r4b/conceptmap.html)** A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.
- [Update ConceptMap with identifier {identifier}](https://api-reference.oystehr.com/reference/put_conceptmap-identifier.md): **[ConceptMap on the FHIR specification website.](https://www.hl7.org/fhir/r4b/conceptmap.html)** A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models. The body should be a valid FHIR object for ConceptMap. Here is an example: ```json { "resourceType": "ConceptMap", "id": "cm-address-type-v3", "text": { "status": "generated", "div": "" }, "url": "http://hl7.org/fhir/ConceptMap/cm-address-type-v3", "version": "4.0.1", "name": "v3.AddressType", "title": "v3 map for AddressType", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7 (FHIR Project)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" }, { "system": "email", "value": "fhir@lists.hl7.org" } ] } ], "sourceCanonical": "http://hl7.org/fhir/ValueSet/address-type", "targetCanonical": "http://terminology.hl7.org/ValueSet/v3-AddressUse", "group": [ { "source": "http://hl7.org/fhir/address-type", "target": "http://terminology.hl7.org/CodeSystem/v3-AddressUse", "element": [ { "code": "postal", "target": [ { "code": "PST", "equivalence": "equal" } ] }, { "code": "physical", "target": [ { "code": "PHYS", "equivalence": "equal" } ] } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`ConceptMap`](https://www.hl7.org/fhir/r4b/ConceptMap.html).
- [Patch ConceptMap with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_conceptmap-identifier.md): **[ConceptMap on the FHIR specification website.](https://www.hl7.org/fhir/r4b/conceptmap.html)** A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models. The body should be a list of valid JSON patches for ConceptMap. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ConceptMap with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_conceptmap-identifier.md): **[ConceptMap on the FHIR specification website.](https://www.hl7.org/fhir/r4b/conceptmap.html)** A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.
- [Get history of ConceptMap with identifier {identifier}](https://api-reference.oystehr.com/reference/get_conceptmap-identifier-history.md): **[ConceptMap on the FHIR specification website.](https://www.hl7.org/fhir/r4b/conceptmap.html)** A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.
- [Get ConceptMap with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_conceptmap-identifier-history-versionidentifier.md): **[ConceptMap on the FHIR specification website.](https://www.hl7.org/fhir/r4b/conceptmap.html)** A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.
- [Search Conditions](https://api-reference.oystehr.com/reference/get_condition.md): **[Condition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/condition.html)** A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
- [Create a new Condition](https://api-reference.oystehr.com/reference/post_condition.md): **[Condition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/condition.html)** A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. The body should be a valid FHIR object for Condition. Here is an example: ```json { "resourceType": "Condition", "id": "example", "text": { "status": "generated", "div": "Severe burn of left ear (Date: 24-May 2012)
" }, "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" }, { "system": "http://snomed.info/sct", "code": "439401001", "display": "Diagnosis" } ] } ], "severity": { "coding": [ { "system": "http://snomed.info/sct", "code": "24484000", "display": "Severe" } ] }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "39065001", "display": "Burn of ear" } ], "text": "Burnt Ear" }, "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "49521004", "display": "Left external ear structure" } ], "text": "Left Ear" } ], "subject": { "reference": "Patient/example" }, "onsetDateTime": "2012-05-24" } ``` You can reference the FHIR documentation to determine the format for [`Condition`](https://www.hl7.org/fhir/r4b/Condition.html).
- [Search Conditions](https://api-reference.oystehr.com/reference/post_condition-search.md): **[Condition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/condition.html)** A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
- [Get Condition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_condition-identifier.md): **[Condition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/condition.html)** A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
- [Update Condition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_condition-identifier.md): **[Condition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/condition.html)** A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. The body should be a valid FHIR object for Condition. Here is an example: ```json { "resourceType": "Condition", "id": "example", "text": { "status": "generated", "div": "Severe burn of left ear (Date: 24-May 2012)
" }, "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" }, { "system": "http://snomed.info/sct", "code": "439401001", "display": "Diagnosis" } ] } ], "severity": { "coding": [ { "system": "http://snomed.info/sct", "code": "24484000", "display": "Severe" } ] }, "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "39065001", "display": "Burn of ear" } ], "text": "Burnt Ear" }, "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "49521004", "display": "Left external ear structure" } ], "text": "Left Ear" } ], "subject": { "reference": "Patient/example" }, "onsetDateTime": "2012-05-24" } ``` You can reference the FHIR documentation to determine the format for [`Condition`](https://www.hl7.org/fhir/r4b/Condition.html).
- [Patch Condition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_condition-identifier.md): **[Condition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/condition.html)** A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. The body should be a list of valid JSON patches for Condition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Condition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_condition-identifier.md): **[Condition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/condition.html)** A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
- [Get history of Condition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_condition-identifier-history.md): **[Condition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/condition.html)** A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
- [Get Condition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_condition-identifier-history-versionidentifier.md): **[Condition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/condition.html)** A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
- [Search Consents](https://api-reference.oystehr.com/reference/get_consent.md): **[Consent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/consent.html)** A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
- [Create a new Consent](https://api-reference.oystehr.com/reference/post_consent.md): **[Consent on the FHIR specification website.](https://www.hl7.org/fhir/r4b/consent.html)** A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. The body should be a valid FHIR object for Consent. Here is an example: ```json { "resourceType": "Consent", "id": "consent-example-Emergency", "text": { "status": "generated", "div": "\n
\n\tWithhold Authorization for Treatment rule for Emegency Treatment\n\t
\n
\n Patient "P. van de Heuvel" wishes to have no data at the Good Health Psychiatric Hospital \n available rule for Emergency treatment use.\n An overall Deny consent Directive, with an exception "Permit" of purposeOfUse "ETREAT" \n at "Good Health" hospital, and exception "Deny" all other purposeOfUse from good health hospital.\n
\n
\n
\n\tWithhold Authorization for Treatment rule for Emegency Treatment\n\t
\n
\n Patient "P. van de Heuvel" wishes to have no data at the Good Health Psychiatric Hospital \n available rule for Emergency treatment use.\n An overall Deny consent Directive, with an exception "Permit" of purposeOfUse "ETREAT" \n at "Good Health" hospital, and exception "Deny" all other purposeOfUse from good health hospital.\n
\n
A human-readable rendering of the contract
" }, "identifier": [ { "system": "http://happyvalley.com/contract", "value": "12347" } ], "term": [ { "offer": { "text": "Can't refuse" }, "asset": [ { "type": [ { "coding": [ { "system": "urn:ietf:rfc:3986", "code": "RicardianContract" } ] } ], "subtype": [ { "text": "sample" } ], "period": [ { "start": "2017-06-01" } ], "valuedItem": [ { "entityCodeableConcept": { "text": "Ford Bobcat" }, "identifier": { "system": "http://somewhere.motor-vehicle.com/vin", "value": "XXSVT34-7665t952236" }, "effectiveTime": "1995", "quantity": { "value": 1 }, "unitPrice": { "value": 200, "currency": "CAD" }, "factor": 1, "points": 1, "net": { "value": 200, "currency": "CAD" } } ] } ] } ], "rule": [ { "contentAttachment": { "contentType": "application/txt", "url": "http://www.rfc-editor.org/bcp/bcp13.txt" } } ], "legallyBindingAttachment": { "contentType": "application/pdf", "url": "http://www.aws3.com/storage/doc.pdf" } } ``` You can reference the FHIR documentation to determine the format for [`Contract`](https://www.hl7.org/fhir/r4b/Contract.html).
- [Search Contracts](https://api-reference.oystehr.com/reference/post_contract-search.md): **[Contract on the FHIR specification website.](https://www.hl7.org/fhir/r4b/contract.html)** Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
- [Get Contract with identifier {identifier}](https://api-reference.oystehr.com/reference/get_contract-identifier.md): **[Contract on the FHIR specification website.](https://www.hl7.org/fhir/r4b/contract.html)** Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
- [Update Contract with identifier {identifier}](https://api-reference.oystehr.com/reference/put_contract-identifier.md): **[Contract on the FHIR specification website.](https://www.hl7.org/fhir/r4b/contract.html)** Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement. The body should be a valid FHIR object for Contract. Here is an example: ```json { "resourceType": "Contract", "id": "C-123", "text": { "status": "generated", "div": "A human-readable rendering of the contract
" }, "identifier": [ { "system": "http://happyvalley.com/contract", "value": "12347" } ], "term": [ { "offer": { "text": "Can't refuse" }, "asset": [ { "type": [ { "coding": [ { "system": "urn:ietf:rfc:3986", "code": "RicardianContract" } ] } ], "subtype": [ { "text": "sample" } ], "period": [ { "start": "2017-06-01" } ], "valuedItem": [ { "entityCodeableConcept": { "text": "Ford Bobcat" }, "identifier": { "system": "http://somewhere.motor-vehicle.com/vin", "value": "XXSVT34-7665t952236" }, "effectiveTime": "1995", "quantity": { "value": 1 }, "unitPrice": { "value": 200, "currency": "CAD" }, "factor": 1, "points": 1, "net": { "value": 200, "currency": "CAD" } } ] } ] } ], "rule": [ { "contentAttachment": { "contentType": "application/txt", "url": "http://www.rfc-editor.org/bcp/bcp13.txt" } } ], "legallyBindingAttachment": { "contentType": "application/pdf", "url": "http://www.aws3.com/storage/doc.pdf" } } ``` You can reference the FHIR documentation to determine the format for [`Contract`](https://www.hl7.org/fhir/r4b/Contract.html).
- [Patch Contract with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_contract-identifier.md): **[Contract on the FHIR specification website.](https://www.hl7.org/fhir/r4b/contract.html)** Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement. The body should be a list of valid JSON patches for Contract. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Contract with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_contract-identifier.md): **[Contract on the FHIR specification website.](https://www.hl7.org/fhir/r4b/contract.html)** Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
- [Get history of Contract with identifier {identifier}](https://api-reference.oystehr.com/reference/get_contract-identifier-history.md): **[Contract on the FHIR specification website.](https://www.hl7.org/fhir/r4b/contract.html)** Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
- [Get Contract with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_contract-identifier-history-versionidentifier.md): **[Contract on the FHIR specification website.](https://www.hl7.org/fhir/r4b/contract.html)** Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
- [Search Coverages](https://api-reference.oystehr.com/reference/get_coverage.md): **[Coverage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverage.html)** Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
- [Create a new Coverage](https://api-reference.oystehr.com/reference/post_coverage.md): **[Coverage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverage.html)** Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The body should be a valid FHIR object for Coverage. Here is an example: ```json { "resourceType": "Coverage", "id": "7547E", "text": { "status": "generated", "div": "A human-readable rendering of the European Health Insurance Card
" }, "identifier": [ { "system": "http://ehic.com/insurer/123456789/member", "value": "A123456780" } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "EHCPOL", "display": "extended healthcare" } ] }, "subscriber": { "reference": "Patient/5" }, "beneficiary": { "reference": "Patient/5" }, "relationship": { "coding": [ { "code": "self" } ] }, "period": { "end": "2012-03-17" }, "payor": [ { "identifier": { "system": "http://ehic.com/insurer", "value": "123456789" } } ] } ``` You can reference the FHIR documentation to determine the format for [`Coverage`](https://www.hl7.org/fhir/r4b/Coverage.html).
- [Search Coverages](https://api-reference.oystehr.com/reference/post_coverage-search.md): **[Coverage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverage.html)** Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
- [Get Coverage with identifier {identifier}](https://api-reference.oystehr.com/reference/get_coverage-identifier.md): **[Coverage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverage.html)** Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
- [Update Coverage with identifier {identifier}](https://api-reference.oystehr.com/reference/put_coverage-identifier.md): **[Coverage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverage.html)** Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The body should be a valid FHIR object for Coverage. Here is an example: ```json { "resourceType": "Coverage", "id": "7547E", "text": { "status": "generated", "div": "A human-readable rendering of the European Health Insurance Card
" }, "identifier": [ { "system": "http://ehic.com/insurer/123456789/member", "value": "A123456780" } ], "status": "active", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "EHCPOL", "display": "extended healthcare" } ] }, "subscriber": { "reference": "Patient/5" }, "beneficiary": { "reference": "Patient/5" }, "relationship": { "coding": [ { "code": "self" } ] }, "period": { "end": "2012-03-17" }, "payor": [ { "identifier": { "system": "http://ehic.com/insurer", "value": "123456789" } } ] } ``` You can reference the FHIR documentation to determine the format for [`Coverage`](https://www.hl7.org/fhir/r4b/Coverage.html).
- [Patch Coverage with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_coverage-identifier.md): **[Coverage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverage.html)** Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The body should be a list of valid JSON patches for Coverage. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Coverage with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_coverage-identifier.md): **[Coverage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverage.html)** Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
- [Get history of Coverage with identifier {identifier}](https://api-reference.oystehr.com/reference/get_coverage-identifier-history.md): **[Coverage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverage.html)** Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
- [Get Coverage with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_coverage-identifier-history-versionidentifier.md): **[Coverage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverage.html)** Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
- [Search CoverageEligibilityRequests](https://api-reference.oystehr.com/reference/get_coverageeligibilityrequest.md): **[CoverageEligibilityRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityrequest.html)** The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.
- [Create a new CoverageEligibilityRequest](https://api-reference.oystehr.com/reference/post_coverageeligibilityrequest.md): **[CoverageEligibilityRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityrequest.html)** The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy. The body should be a valid FHIR object for CoverageEligibilityRequest. Here is an example: ```json { "resourceType": "CoverageEligibilityRequest", "id": "52345", "text": { "status": "generated", "div": "A human-readable rendering of the CoverageEligibilityRequest
" }, "identifier": [ { "system": "http://happyvalley.com/coverageelegibilityrequest", "value": "52345" } ], "status": "active", "priority": { "coding": [ { "code": "normal" } ] }, "purpose": [ "validation" ], "patient": { "reference": "Patient/pat1" }, "created": "2014-08-16", "provider": { "reference": "Organization/1" }, "insurer": { "reference": "Organization/2" }, "insurance": [ { "focal": true, "coverage": { "reference": "Coverage/9876B1" } } ] } ``` You can reference the FHIR documentation to determine the format for [`CoverageEligibilityRequest`](https://www.hl7.org/fhir/r4b/CoverageEligibilityRequest.html).
- [Search CoverageEligibilityRequests](https://api-reference.oystehr.com/reference/post_coverageeligibilityrequest-search.md): **[CoverageEligibilityRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityrequest.html)** The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.
- [Get CoverageEligibilityRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/get_coverageeligibilityrequest-identifier.md): **[CoverageEligibilityRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityrequest.html)** The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.
- [Update CoverageEligibilityRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/put_coverageeligibilityrequest-identifier.md): **[CoverageEligibilityRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityrequest.html)** The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy. The body should be a valid FHIR object for CoverageEligibilityRequest. Here is an example: ```json { "resourceType": "CoverageEligibilityRequest", "id": "52345", "text": { "status": "generated", "div": "A human-readable rendering of the CoverageEligibilityRequest
" }, "identifier": [ { "system": "http://happyvalley.com/coverageelegibilityrequest", "value": "52345" } ], "status": "active", "priority": { "coding": [ { "code": "normal" } ] }, "purpose": [ "validation" ], "patient": { "reference": "Patient/pat1" }, "created": "2014-08-16", "provider": { "reference": "Organization/1" }, "insurer": { "reference": "Organization/2" }, "insurance": [ { "focal": true, "coverage": { "reference": "Coverage/9876B1" } } ] } ``` You can reference the FHIR documentation to determine the format for [`CoverageEligibilityRequest`](https://www.hl7.org/fhir/r4b/CoverageEligibilityRequest.html).
- [Patch CoverageEligibilityRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_coverageeligibilityrequest-identifier.md): **[CoverageEligibilityRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityrequest.html)** The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy. The body should be a list of valid JSON patches for CoverageEligibilityRequest. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete CoverageEligibilityRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_coverageeligibilityrequest-identifier.md): **[CoverageEligibilityRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityrequest.html)** The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.
- [Get history of CoverageEligibilityRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/get_coverageeligibilityrequest-identifier-history.md): **[CoverageEligibilityRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityrequest.html)** The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.
- [Get CoverageEligibilityRequest with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_coverageeligibilityrequest-identifier-history-versionidentifier.md): **[CoverageEligibilityRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityrequest.html)** The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.
- [Search CoverageEligibilityResponses](https://api-reference.oystehr.com/reference/get_coverageeligibilityresponse.md): **[CoverageEligibilityResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityresponse.html)** This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
- [Create a new CoverageEligibilityResponse](https://api-reference.oystehr.com/reference/post_coverageeligibilityresponse.md): **[CoverageEligibilityResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityresponse.html)** This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource. The body should be a valid FHIR object for CoverageEligibilityResponse. Here is an example: ```json { "resourceType": "CoverageEligibilityResponse", "id": "E2500", "text": { "status": "generated", "div": "A human-readable rendering of the CoverageEligibilityResponse.
" }, "identifier": [ { "system": "http://www.BenefitsInc.com/fhir/coverageeligibilityresponse", "value": "881234" } ], "status": "active", "purpose": [ "validation" ], "patient": { "reference": "Patient/pat1" }, "created": "2014-08-16", "request": { "reference": "http://www.BenefitsInc.com/fhir/coverageeligibilityrequest/225476332402" }, "outcome": "complete", "disposition": "Policy is currently in-force.", "insurer": { "reference": "Organization/2" }, "insurance": [ { "coverage": { "reference": "Coverage/9876B1" }, "inforce": true } ] } ``` You can reference the FHIR documentation to determine the format for [`CoverageEligibilityResponse`](https://www.hl7.org/fhir/r4b/CoverageEligibilityResponse.html).
- [Search CoverageEligibilityResponses](https://api-reference.oystehr.com/reference/post_coverageeligibilityresponse-search.md): **[CoverageEligibilityResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityresponse.html)** This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
- [Get CoverageEligibilityResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/get_coverageeligibilityresponse-identifier.md): **[CoverageEligibilityResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityresponse.html)** This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
- [Update CoverageEligibilityResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/put_coverageeligibilityresponse-identifier.md): **[CoverageEligibilityResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityresponse.html)** This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource. The body should be a valid FHIR object for CoverageEligibilityResponse. Here is an example: ```json { "resourceType": "CoverageEligibilityResponse", "id": "E2500", "text": { "status": "generated", "div": "A human-readable rendering of the CoverageEligibilityResponse.
" }, "identifier": [ { "system": "http://www.BenefitsInc.com/fhir/coverageeligibilityresponse", "value": "881234" } ], "status": "active", "purpose": [ "validation" ], "patient": { "reference": "Patient/pat1" }, "created": "2014-08-16", "request": { "reference": "http://www.BenefitsInc.com/fhir/coverageeligibilityrequest/225476332402" }, "outcome": "complete", "disposition": "Policy is currently in-force.", "insurer": { "reference": "Organization/2" }, "insurance": [ { "coverage": { "reference": "Coverage/9876B1" }, "inforce": true } ] } ``` You can reference the FHIR documentation to determine the format for [`CoverageEligibilityResponse`](https://www.hl7.org/fhir/r4b/CoverageEligibilityResponse.html).
- [Patch CoverageEligibilityResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_coverageeligibilityresponse-identifier.md): **[CoverageEligibilityResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityresponse.html)** This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource. The body should be a list of valid JSON patches for CoverageEligibilityResponse. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete CoverageEligibilityResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_coverageeligibilityresponse-identifier.md): **[CoverageEligibilityResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityresponse.html)** This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
- [Get history of CoverageEligibilityResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/get_coverageeligibilityresponse-identifier-history.md): **[CoverageEligibilityResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityresponse.html)** This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
- [Get CoverageEligibilityResponse with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_coverageeligibilityresponse-identifier-history-versionidentifier.md): **[CoverageEligibilityResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/coverageeligibilityresponse.html)** This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
- [Search DetectedIssues](https://api-reference.oystehr.com/reference/get_detectedissue.md): **[DetectedIssue on the FHIR specification website.](https://www.hl7.org/fhir/r4b/detectedissue.html)** Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
- [Create a new DetectedIssue](https://api-reference.oystehr.com/reference/post_detectedissue.md): **[DetectedIssue on the FHIR specification website.](https://www.hl7.org/fhir/r4b/detectedissue.html)** Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc. The body should be a valid FHIR object for DetectedIssue. Here is an example: ```json { "resourceType": "DetectedIssue", "id": "allergy", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "final" } ``` You can reference the FHIR documentation to determine the format for [`DetectedIssue`](https://www.hl7.org/fhir/r4b/DetectedIssue.html).
- [Search DetectedIssues](https://api-reference.oystehr.com/reference/post_detectedissue-search.md): **[DetectedIssue on the FHIR specification website.](https://www.hl7.org/fhir/r4b/detectedissue.html)** Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
- [Get DetectedIssue with identifier {identifier}](https://api-reference.oystehr.com/reference/get_detectedissue-identifier.md): **[DetectedIssue on the FHIR specification website.](https://www.hl7.org/fhir/r4b/detectedissue.html)** Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
- [Update DetectedIssue with identifier {identifier}](https://api-reference.oystehr.com/reference/put_detectedissue-identifier.md): **[DetectedIssue on the FHIR specification website.](https://www.hl7.org/fhir/r4b/detectedissue.html)** Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc. The body should be a valid FHIR object for DetectedIssue. Here is an example: ```json { "resourceType": "DetectedIssue", "id": "allergy", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "final" } ``` You can reference the FHIR documentation to determine the format for [`DetectedIssue`](https://www.hl7.org/fhir/r4b/DetectedIssue.html).
- [Patch DetectedIssue with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_detectedissue-identifier.md): **[DetectedIssue on the FHIR specification website.](https://www.hl7.org/fhir/r4b/detectedissue.html)** Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc. The body should be a list of valid JSON patches for DetectedIssue. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete DetectedIssue with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_detectedissue-identifier.md): **[DetectedIssue on the FHIR specification website.](https://www.hl7.org/fhir/r4b/detectedissue.html)** Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
- [Get history of DetectedIssue with identifier {identifier}](https://api-reference.oystehr.com/reference/get_detectedissue-identifier-history.md): **[DetectedIssue on the FHIR specification website.](https://www.hl7.org/fhir/r4b/detectedissue.html)** Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
- [Get DetectedIssue with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_detectedissue-identifier-history-versionidentifier.md): **[DetectedIssue on the FHIR specification website.](https://www.hl7.org/fhir/r4b/detectedissue.html)** Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
- [Search Devices](https://api-reference.oystehr.com/reference/get_device.md): **[Device on the FHIR specification website.](https://www.hl7.org/fhir/r4b/device.html)** A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
- [Create a new Device](https://api-reference.oystehr.com/reference/post_device.md): **[Device on the FHIR specification website.](https://www.hl7.org/fhir/r4b/device.html)** A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. The body should be a valid FHIR object for Device. Here is an example: ```json { "resourceType": "Device", "id": "example", "text": { "status": "generated", "div": "Generated Narrative with Details
id: example
identifier: 345675
Generated Narrative with Details
id: example
identifier: 345675
Generated Narrative with Details
id: example
identifier: 0
Generated Narrative with Details
id: example
identifier: 0
Generated Narrative with Details
id: example
identifier: 345675
type: MDC_PULS_OXIM_SAT_O2 (Details : {urn:iso:std:iso:11073:10101 code '150456' = '150456', given as 'MDC_PULS_OXIM_SAT_O2'})
unit: MDC_DIM_PERCENT (Details : {urn:iso:std:iso:11073:10101 code '262688' = '262688', given as 'MDC_DIM_PERCENT'})
source: Device/dev1
parent: DeviceDefinition/dc102
operationalStatus: on
color: blue
category: measurement
measurementPeriod: Do Once per 1 seconds
Calibrations
| - | Type | State | Time |
| * | two-point | calibrated | 28/12/2016 9:03:04 AM |
Generated Narrative with Details
id: example
identifier: 345675
type: MDC_PULS_OXIM_SAT_O2 (Details : {urn:iso:std:iso:11073:10101 code '150456' = '150456', given as 'MDC_PULS_OXIM_SAT_O2'})
unit: MDC_DIM_PERCENT (Details : {urn:iso:std:iso:11073:10101 code '262688' = '262688', given as 'MDC_DIM_PERCENT'})
source: Device/dev1
parent: DeviceDefinition/dc102
operationalStatus: on
color: blue
category: measurement
measurementPeriod: Do Once per 1 seconds
Calibrations
| - | Type | State | Time |
| * | two-point | calibrated | 28/12/2016 9:03:04 AM |
A Financial Management Attachment example
" }, "contained": [ { "resourceType": "Organization", "id": "org-1", "identifier": [ { "system": "http://nationalidentifiers.org/insurers", "value": "52345" } ] }, { "resourceType": "DocumentReference", "id": "a1", "status": "current", "content": [ { "attachment": { "contentType": "application/pdf", "data": "SGVsbG8=", "title": "accident notes 20100201.pdf", "creation": "2010-02-01T11:50:23-05:00" } } ] }, { "resourceType": "DocumentReference", "id": "a2", "status": "current", "content": [ { "attachment": { "contentType": "application/pdf", "url": "http://happyvalley.com/docs/AB12345", "size": 104274, "hash": "SGVsbG8gdGhlcmU=", "creation": "2010-02-01T10:57:34+01:00" } } ] } ], "identifier": [ { "system": "http://happyvalley.com/supportingdocumentation", "value": "52345" } ], "status": "current", "created": "2014-09-21T11:50:23-05:00", "recipient": [ { "reference": "#org-1" } ], "content": [ { "reference": "#a1" }, { "reference": "#a2" }, { "reference": "DocumentReference/example" }, { "reference": "DiagnosticReport/f001" } ], "related": [ { "identifier": { "system": "http://happyvalley.com/claim", "value": "12345" } }, { "identifier": { "system": "http://www.BenefitsInc.com/fhir/remittance", "value": "R3500" } } ] } ``` You can reference the FHIR documentation to determine the format for [`DocumentManifest`](https://www.hl7.org/fhir/r4b/DocumentManifest.html).
- [Search DocumentManifests](https://api-reference.oystehr.com/reference/post_documentmanifest-search.md): **[DocumentManifest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentmanifest.html)** A collection of documents compiled for a purpose together with metadata that applies to the collection.
- [Get DocumentManifest with identifier {identifier}](https://api-reference.oystehr.com/reference/get_documentmanifest-identifier.md): **[DocumentManifest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentmanifest.html)** A collection of documents compiled for a purpose together with metadata that applies to the collection.
- [Update DocumentManifest with identifier {identifier}](https://api-reference.oystehr.com/reference/put_documentmanifest-identifier.md): **[DocumentManifest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentmanifest.html)** A collection of documents compiled for a purpose together with metadata that applies to the collection. The body should be a valid FHIR object for DocumentManifest. Here is an example: ```json { "resourceType": "DocumentManifest", "id": "654789", "text": { "status": "generated", "div": "A Financial Management Attachment example
" }, "contained": [ { "resourceType": "Organization", "id": "org-1", "identifier": [ { "system": "http://nationalidentifiers.org/insurers", "value": "52345" } ] }, { "resourceType": "DocumentReference", "id": "a1", "status": "current", "content": [ { "attachment": { "contentType": "application/pdf", "data": "SGVsbG8=", "title": "accident notes 20100201.pdf", "creation": "2010-02-01T11:50:23-05:00" } } ] }, { "resourceType": "DocumentReference", "id": "a2", "status": "current", "content": [ { "attachment": { "contentType": "application/pdf", "url": "http://happyvalley.com/docs/AB12345", "size": 104274, "hash": "SGVsbG8gdGhlcmU=", "creation": "2010-02-01T10:57:34+01:00" } } ] } ], "identifier": [ { "system": "http://happyvalley.com/supportingdocumentation", "value": "52345" } ], "status": "current", "created": "2014-09-21T11:50:23-05:00", "recipient": [ { "reference": "#org-1" } ], "content": [ { "reference": "#a1" }, { "reference": "#a2" }, { "reference": "DocumentReference/example" }, { "reference": "DiagnosticReport/f001" } ], "related": [ { "identifier": { "system": "http://happyvalley.com/claim", "value": "12345" } }, { "identifier": { "system": "http://www.BenefitsInc.com/fhir/remittance", "value": "R3500" } } ] } ``` You can reference the FHIR documentation to determine the format for [`DocumentManifest`](https://www.hl7.org/fhir/r4b/DocumentManifest.html).
- [Patch DocumentManifest with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_documentmanifest-identifier.md): **[DocumentManifest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentmanifest.html)** A collection of documents compiled for a purpose together with metadata that applies to the collection. The body should be a list of valid JSON patches for DocumentManifest. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete DocumentManifest with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_documentmanifest-identifier.md): **[DocumentManifest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentmanifest.html)** A collection of documents compiled for a purpose together with metadata that applies to the collection.
- [Get history of DocumentManifest with identifier {identifier}](https://api-reference.oystehr.com/reference/get_documentmanifest-identifier-history.md): **[DocumentManifest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentmanifest.html)** A collection of documents compiled for a purpose together with metadata that applies to the collection.
- [Get DocumentManifest with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_documentmanifest-identifier-history-versionidentifier.md): **[DocumentManifest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentmanifest.html)** A collection of documents compiled for a purpose together with metadata that applies to the collection.
- [Search DocumentReferences](https://api-reference.oystehr.com/reference/get_documentreference.md): **[DocumentReference on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentreference.html)** A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
- [Create a new DocumentReference](https://api-reference.oystehr.com/reference/post_documentreference.md): **[DocumentReference on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentreference.html)** A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text. The body should be a valid FHIR object for DocumentReference. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`DocumentReference`](https://www.hl7.org/fhir/r4b/DocumentReference.html).
- [Search DocumentReferences](https://api-reference.oystehr.com/reference/post_documentreference-search.md): **[DocumentReference on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentreference.html)** A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
- [Get DocumentReference with identifier {identifier}](https://api-reference.oystehr.com/reference/get_documentreference-identifier.md): **[DocumentReference on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentreference.html)** A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
- [Update DocumentReference with identifier {identifier}](https://api-reference.oystehr.com/reference/put_documentreference-identifier.md): **[DocumentReference on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentreference.html)** A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text. The body should be a valid FHIR object for DocumentReference. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`DocumentReference`](https://www.hl7.org/fhir/r4b/DocumentReference.html).
- [Patch DocumentReference with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_documentreference-identifier.md): **[DocumentReference on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentreference.html)** A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text. The body should be a list of valid JSON patches for DocumentReference. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete DocumentReference with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_documentreference-identifier.md): **[DocumentReference on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentreference.html)** A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
- [Get history of DocumentReference with identifier {identifier}](https://api-reference.oystehr.com/reference/get_documentreference-identifier-history.md): **[DocumentReference on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentreference.html)** A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
- [Get DocumentReference with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_documentreference-identifier-history-versionidentifier.md): **[DocumentReference on the FHIR specification website.](https://www.hl7.org/fhir/r4b/documentreference.html)** A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
- [Search Encounters](https://api-reference.oystehr.com/reference/get_encounter.md): **[Encounter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/encounter.html)** An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
- [Create a new Encounter](https://api-reference.oystehr.com/reference/post_encounter.md): **[Encounter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/encounter.html)** An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. The body should be a valid FHIR object for Encounter. Here is an example: ```json { "resourceType": "Encounter", "id": "example", "text": { "status": "generated", "div": "Encounter with patient @example
" }, "status": "in-progress", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "IMP", "display": "inpatient encounter" }, "subject": { "reference": "Patient/example" } } ``` You can reference the FHIR documentation to determine the format for [`Encounter`](https://www.hl7.org/fhir/r4b/Encounter.html).
- [Search Encounters](https://api-reference.oystehr.com/reference/post_encounter-search.md): **[Encounter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/encounter.html)** An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
- [Get Encounter with identifier {identifier}](https://api-reference.oystehr.com/reference/get_encounter-identifier.md): **[Encounter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/encounter.html)** An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
- [Update Encounter with identifier {identifier}](https://api-reference.oystehr.com/reference/put_encounter-identifier.md): **[Encounter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/encounter.html)** An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. The body should be a valid FHIR object for Encounter. Here is an example: ```json { "resourceType": "Encounter", "id": "example", "text": { "status": "generated", "div": "Encounter with patient @example
" }, "status": "in-progress", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "IMP", "display": "inpatient encounter" }, "subject": { "reference": "Patient/example" } } ``` You can reference the FHIR documentation to determine the format for [`Encounter`](https://www.hl7.org/fhir/r4b/Encounter.html).
- [Patch Encounter with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_encounter-identifier.md): **[Encounter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/encounter.html)** An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. The body should be a list of valid JSON patches for Encounter. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Encounter with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_encounter-identifier.md): **[Encounter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/encounter.html)** An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
- [Get history of Encounter with identifier {identifier}](https://api-reference.oystehr.com/reference/get_encounter-identifier-history.md): **[Encounter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/encounter.html)** An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
- [Get Encounter with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_encounter-identifier-history-versionidentifier.md): **[Encounter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/encounter.html)** An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
- [Search Endpoints](https://api-reference.oystehr.com/reference/get_endpoint.md): **[Endpoint on the FHIR specification website.](https://www.hl7.org/fhir/r4b/endpoint.html)** The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
- [Create a new Endpoint](https://api-reference.oystehr.com/reference/post_endpoint.md): **[Endpoint on the FHIR specification website.](https://www.hl7.org/fhir/r4b/endpoint.html)** The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information. The body should be a valid FHIR object for Endpoint. Here is an example: ```json { "resourceType": "Endpoint", "id": "direct-endpoint", "text": { "status": "generated", "div": "Generated Narrative with Details
id: direct-endpoint
status: active
connectionType: direct-project (Details: [not stated] code direct-project = 'direct-project', stated as 'null')
name: MARTIN SMIETANKA
managingOrganization: Organization/299
payloadType: urn:hl7-org:sdwg:ccda-structuredBody:1.1 (Details : {urn:oid:1.3.6.1.4.1.19376.1.2.3 code 'urn:hl7-org:sdwg:ccda-structuredBody:1.1' = 'urn:hl7-org:sdwg:ccda-structuredBody:1.1)
address: MARTIN.SMIETANKA@directnppes.com
Generated Narrative with Details
id: direct-endpoint
status: active
connectionType: direct-project (Details: [not stated] code direct-project = 'direct-project', stated as 'null')
name: MARTIN SMIETANKA
managingOrganization: Organization/299
payloadType: urn:hl7-org:sdwg:ccda-structuredBody:1.1 (Details : {urn:oid:1.3.6.1.4.1.19376.1.2.3 code 'urn:hl7-org:sdwg:ccda-structuredBody:1.1' = 'urn:hl7-org:sdwg:ccda-structuredBody:1.1)
address: MARTIN.SMIETANKA@directnppes.com
A human-readable rendering of the EnrollmentRequest.
" }, "identifier": [ { "system": "http://happyvalley.com/enrollmentrequest", "value": "EN22345" } ], "status": "active", "created": "2014-08-16", "insurer": { "reference": "Organization/2" }, "provider": { "reference": "Organization/1" }, "candidate": { "reference": "Patient/1" }, "coverage": { "reference": "Coverage/9876B1" } } ``` You can reference the FHIR documentation to determine the format for [`EnrollmentRequest`](https://www.hl7.org/fhir/r4b/EnrollmentRequest.html).
- [Search EnrollmentRequests](https://api-reference.oystehr.com/reference/post_enrollmentrequest-search.md): **[EnrollmentRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentrequest.html)** This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
- [Get EnrollmentRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/get_enrollmentrequest-identifier.md): **[EnrollmentRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentrequest.html)** This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
- [Update EnrollmentRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/put_enrollmentrequest-identifier.md): **[EnrollmentRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentrequest.html)** This resource provides the insurance enrollment details to the insurer regarding a specified coverage. The body should be a valid FHIR object for EnrollmentRequest. Here is an example: ```json { "resourceType": "EnrollmentRequest", "id": "22345", "text": { "status": "generated", "div": "A human-readable rendering of the EnrollmentRequest.
" }, "identifier": [ { "system": "http://happyvalley.com/enrollmentrequest", "value": "EN22345" } ], "status": "active", "created": "2014-08-16", "insurer": { "reference": "Organization/2" }, "provider": { "reference": "Organization/1" }, "candidate": { "reference": "Patient/1" }, "coverage": { "reference": "Coverage/9876B1" } } ``` You can reference the FHIR documentation to determine the format for [`EnrollmentRequest`](https://www.hl7.org/fhir/r4b/EnrollmentRequest.html).
- [Patch EnrollmentRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_enrollmentrequest-identifier.md): **[EnrollmentRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentrequest.html)** This resource provides the insurance enrollment details to the insurer regarding a specified coverage. The body should be a list of valid JSON patches for EnrollmentRequest. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete EnrollmentRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_enrollmentrequest-identifier.md): **[EnrollmentRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentrequest.html)** This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
- [Get history of EnrollmentRequest with identifier {identifier}](https://api-reference.oystehr.com/reference/get_enrollmentrequest-identifier-history.md): **[EnrollmentRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentrequest.html)** This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
- [Get EnrollmentRequest with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_enrollmentrequest-identifier-history-versionidentifier.md): **[EnrollmentRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentrequest.html)** This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
- [Search EnrollmentResponses](https://api-reference.oystehr.com/reference/get_enrollmentresponse.md): **[EnrollmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentresponse.html)** This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
- [Create a new EnrollmentResponse](https://api-reference.oystehr.com/reference/post_enrollmentresponse.md): **[EnrollmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentresponse.html)** This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource. The body should be a valid FHIR object for EnrollmentResponse. Here is an example: ```json { "resourceType": "EnrollmentResponse", "id": "ER2500", "text": { "status": "generated", "div": "A human-readable rendering of the EnrollmentResponse
" }, "identifier": [ { "system": "http://www.BenefitsInc.com/fhir/enrollmentresponse", "value": "781234" } ], "status": "active", "request": { "reference": "http://www.BenefitsInc.com/fhir/eligibility/225476332402" }, "outcome": "complete", "disposition": "Dependant added to policy.", "created": "2014-08-16", "organization": { "reference": "Organization/2" }, "requestProvider": { "reference": "Organization/1" } } ``` You can reference the FHIR documentation to determine the format for [`EnrollmentResponse`](https://www.hl7.org/fhir/r4b/EnrollmentResponse.html).
- [Search EnrollmentResponses](https://api-reference.oystehr.com/reference/post_enrollmentresponse-search.md): **[EnrollmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentresponse.html)** This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
- [Get EnrollmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/get_enrollmentresponse-identifier.md): **[EnrollmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentresponse.html)** This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
- [Update EnrollmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/put_enrollmentresponse-identifier.md): **[EnrollmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentresponse.html)** This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource. The body should be a valid FHIR object for EnrollmentResponse. Here is an example: ```json { "resourceType": "EnrollmentResponse", "id": "ER2500", "text": { "status": "generated", "div": "A human-readable rendering of the EnrollmentResponse
" }, "identifier": [ { "system": "http://www.BenefitsInc.com/fhir/enrollmentresponse", "value": "781234" } ], "status": "active", "request": { "reference": "http://www.BenefitsInc.com/fhir/eligibility/225476332402" }, "outcome": "complete", "disposition": "Dependant added to policy.", "created": "2014-08-16", "organization": { "reference": "Organization/2" }, "requestProvider": { "reference": "Organization/1" } } ``` You can reference the FHIR documentation to determine the format for [`EnrollmentResponse`](https://www.hl7.org/fhir/r4b/EnrollmentResponse.html).
- [Patch EnrollmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_enrollmentresponse-identifier.md): **[EnrollmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentresponse.html)** This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource. The body should be a list of valid JSON patches for EnrollmentResponse. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete EnrollmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_enrollmentresponse-identifier.md): **[EnrollmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentresponse.html)** This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
- [Get history of EnrollmentResponse with identifier {identifier}](https://api-reference.oystehr.com/reference/get_enrollmentresponse-identifier-history.md): **[EnrollmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentresponse.html)** This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
- [Get EnrollmentResponse with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_enrollmentresponse-identifier-history-versionidentifier.md): **[EnrollmentResponse on the FHIR specification website.](https://www.hl7.org/fhir/r4b/enrollmentresponse.html)** This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
- [Search EpisodeOfCares](https://api-reference.oystehr.com/reference/get_episodeofcare.md): **[EpisodeOfCare on the FHIR specification website.](https://www.hl7.org/fhir/r4b/episodeofcare.html)** An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
- [Create a new EpisodeOfCare](https://api-reference.oystehr.com/reference/post_episodeofcare.md): **[EpisodeOfCare on the FHIR specification website.](https://www.hl7.org/fhir/r4b/episodeofcare.html)** An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time. The body should be a valid FHIR object for EpisodeOfCare. Here is an example: ```json { "resourceType": "EpisodeOfCare", "id": "example", "text": { "status": "generated", "div": "\n HACC Program for Peter James Chalmers at HL7 Healthcare 15 Sept 2014 - current
\n\t\t\twas on leave from 22 Sept - 24 Sept while in respite care\n
" }, "identifier": [ { "system": "http://example.org/sampleepisodeofcare-identifier", "value": "123" } ], "status": "active", "statusHistory": [ { "status": "planned", "period": { "start": "2014-09-01", "end": "2014-09-14" } }, { "status": "active", "period": { "start": "2014-09-15", "end": "2014-09-21" } }, { "status": "onhold", "period": { "start": "2014-09-22", "end": "2014-09-24" } }, { "status": "active", "period": { "start": "2014-09-25" } } ], "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/episodeofcare-type", "code": "hacc", "display": "Home and Community Care" } ] } ], "diagnosis": [ { "condition": { "reference": "Condition/stroke" }, "role": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "CC", "display": "Chief complaint" } ] }, "rank": 1 } ], "patient": { "reference": "Patient/example" }, "managingOrganization": { "reference": "Organization/hl7" }, "period": { "start": "2014-09-01" }, "referralRequest": [ { "display": "Referral from Example Aged Care Services" } ], "careManager": { "reference": "Practitioner/14", "display": "Amanda Assigned" }, "team": [ { "reference": "CareTeam/example", "display": "example care team" } ], "account": [ { "reference": "Account/example", "display": "example account" } ] } ``` You can reference the FHIR documentation to determine the format for [`EpisodeOfCare`](https://www.hl7.org/fhir/r4b/EpisodeOfCare.html).
- [Search EpisodeOfCares](https://api-reference.oystehr.com/reference/post_episodeofcare-search.md): **[EpisodeOfCare on the FHIR specification website.](https://www.hl7.org/fhir/r4b/episodeofcare.html)** An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
- [Get EpisodeOfCare with identifier {identifier}](https://api-reference.oystehr.com/reference/get_episodeofcare-identifier.md): **[EpisodeOfCare on the FHIR specification website.](https://www.hl7.org/fhir/r4b/episodeofcare.html)** An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
- [Update EpisodeOfCare with identifier {identifier}](https://api-reference.oystehr.com/reference/put_episodeofcare-identifier.md): **[EpisodeOfCare on the FHIR specification website.](https://www.hl7.org/fhir/r4b/episodeofcare.html)** An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time. The body should be a valid FHIR object for EpisodeOfCare. Here is an example: ```json { "resourceType": "EpisodeOfCare", "id": "example", "text": { "status": "generated", "div": "\n HACC Program for Peter James Chalmers at HL7 Healthcare 15 Sept 2014 - current
\n\t\t\twas on leave from 22 Sept - 24 Sept while in respite care\n
" }, "identifier": [ { "system": "http://example.org/sampleepisodeofcare-identifier", "value": "123" } ], "status": "active", "statusHistory": [ { "status": "planned", "period": { "start": "2014-09-01", "end": "2014-09-14" } }, { "status": "active", "period": { "start": "2014-09-15", "end": "2014-09-21" } }, { "status": "onhold", "period": { "start": "2014-09-22", "end": "2014-09-24" } }, { "status": "active", "period": { "start": "2014-09-25" } } ], "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/episodeofcare-type", "code": "hacc", "display": "Home and Community Care" } ] } ], "diagnosis": [ { "condition": { "reference": "Condition/stroke" }, "role": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role", "code": "CC", "display": "Chief complaint" } ] }, "rank": 1 } ], "patient": { "reference": "Patient/example" }, "managingOrganization": { "reference": "Organization/hl7" }, "period": { "start": "2014-09-01" }, "referralRequest": [ { "display": "Referral from Example Aged Care Services" } ], "careManager": { "reference": "Practitioner/14", "display": "Amanda Assigned" }, "team": [ { "reference": "CareTeam/example", "display": "example care team" } ], "account": [ { "reference": "Account/example", "display": "example account" } ] } ``` You can reference the FHIR documentation to determine the format for [`EpisodeOfCare`](https://www.hl7.org/fhir/r4b/EpisodeOfCare.html).
- [Patch EpisodeOfCare with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_episodeofcare-identifier.md): **[EpisodeOfCare on the FHIR specification website.](https://www.hl7.org/fhir/r4b/episodeofcare.html)** An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time. The body should be a list of valid JSON patches for EpisodeOfCare. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete EpisodeOfCare with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_episodeofcare-identifier.md): **[EpisodeOfCare on the FHIR specification website.](https://www.hl7.org/fhir/r4b/episodeofcare.html)** An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
- [Get history of EpisodeOfCare with identifier {identifier}](https://api-reference.oystehr.com/reference/get_episodeofcare-identifier-history.md): **[EpisodeOfCare on the FHIR specification website.](https://www.hl7.org/fhir/r4b/episodeofcare.html)** An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
- [Get EpisodeOfCare with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_episodeofcare-identifier-history-versionidentifier.md): **[EpisodeOfCare on the FHIR specification website.](https://www.hl7.org/fhir/r4b/episodeofcare.html)** An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
- [Search EventDefinitions](https://api-reference.oystehr.com/reference/get_eventdefinition.md): **[EventDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/eventdefinition.html)** The EventDefinition resource provides a reusable description of when a particular event can occur.
- [Create a new EventDefinition](https://api-reference.oystehr.com/reference/post_eventdefinition.md): **[EventDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/eventdefinition.html)** The EventDefinition resource provides a reusable description of when a particular event can occur. The body should be a valid FHIR object for EventDefinition. Here is an example: ```json { "resourceType": "EventDefinition", "id": "example", "text": { "status": "generated", "div": "\n
" }, "status": "draft", "purpose": "Monitor all admissions to Emergency", "trigger": [ { "type": "named-event", "name": "monitor-emergency-admissions", "data": [ { "type": "Encounter" } ], "condition": { "description": "Encounter Location = emergency (active/completed encounters, current or previous)", "language": "text/fhirpath", "expression": "(this | %previous).location.where(location = 'Location/emergency' and status in {'active', 'completed'}).exists()" } } ] } ``` You can reference the FHIR documentation to determine the format for [`EventDefinition`](https://www.hl7.org/fhir/r4b/EventDefinition.html).
- [Search EventDefinitions](https://api-reference.oystehr.com/reference/post_eventdefinition-search.md): **[EventDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/eventdefinition.html)** The EventDefinition resource provides a reusable description of when a particular event can occur.
- [Get EventDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_eventdefinition-identifier.md): **[EventDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/eventdefinition.html)** The EventDefinition resource provides a reusable description of when a particular event can occur.
- [Update EventDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_eventdefinition-identifier.md): **[EventDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/eventdefinition.html)** The EventDefinition resource provides a reusable description of when a particular event can occur. The body should be a valid FHIR object for EventDefinition. Here is an example: ```json { "resourceType": "EventDefinition", "id": "example", "text": { "status": "generated", "div": "\n
" }, "status": "draft", "purpose": "Monitor all admissions to Emergency", "trigger": [ { "type": "named-event", "name": "monitor-emergency-admissions", "data": [ { "type": "Encounter" } ], "condition": { "description": "Encounter Location = emergency (active/completed encounters, current or previous)", "language": "text/fhirpath", "expression": "(this | %previous).location.where(location = 'Location/emergency' and status in {'active', 'completed'}).exists()" } } ] } ``` You can reference the FHIR documentation to determine the format for [`EventDefinition`](https://www.hl7.org/fhir/r4b/EventDefinition.html).
- [Patch EventDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_eventdefinition-identifier.md): **[EventDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/eventdefinition.html)** The EventDefinition resource provides a reusable description of when a particular event can occur. The body should be a list of valid JSON patches for EventDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete EventDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_eventdefinition-identifier.md): **[EventDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/eventdefinition.html)** The EventDefinition resource provides a reusable description of when a particular event can occur.
- [Get history of EventDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_eventdefinition-identifier-history.md): **[EventDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/eventdefinition.html)** The EventDefinition resource provides a reusable description of when a particular event can occur.
- [Get EventDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_eventdefinition-identifier-history-versionidentifier.md): **[EventDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/eventdefinition.html)** The EventDefinition resource provides a reusable description of when a particular event can occur.
- [Search Evidences](https://api-reference.oystehr.com/reference/get_evidence.md): **[Evidence on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidence.html)** The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.
- [Create a new Evidence](https://api-reference.oystehr.com/reference/post_evidence.md): **[Evidence on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidence.html)** The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence. The body should be a valid FHIR object for Evidence. Here is an example: ```json { "resourceType": "Evidence", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "draft", "exposureBackground": { "reference": "EvidenceVariable/example" } } ``` You can reference the FHIR documentation to determine the format for [`Evidence`](https://www.hl7.org/fhir/r4b/Evidence.html).
- [Search Evidences](https://api-reference.oystehr.com/reference/post_evidence-search.md): **[Evidence on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidence.html)** The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.
- [Get Evidence with identifier {identifier}](https://api-reference.oystehr.com/reference/get_evidence-identifier.md): **[Evidence on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidence.html)** The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.
- [Update Evidence with identifier {identifier}](https://api-reference.oystehr.com/reference/put_evidence-identifier.md): **[Evidence on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidence.html)** The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence. The body should be a valid FHIR object for Evidence. Here is an example: ```json { "resourceType": "Evidence", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "draft", "exposureBackground": { "reference": "EvidenceVariable/example" } } ``` You can reference the FHIR documentation to determine the format for [`Evidence`](https://www.hl7.org/fhir/r4b/Evidence.html).
- [Patch Evidence with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_evidence-identifier.md): **[Evidence on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidence.html)** The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence. The body should be a list of valid JSON patches for Evidence. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Evidence with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_evidence-identifier.md): **[Evidence on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidence.html)** The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.
- [Get history of Evidence with identifier {identifier}](https://api-reference.oystehr.com/reference/get_evidence-identifier-history.md): **[Evidence on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidence.html)** The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.
- [Get Evidence with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_evidence-identifier-history-versionidentifier.md): **[Evidence on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidence.html)** The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.
- [Search EvidenceReports](https://api-reference.oystehr.com/reference/get_evidencereport.md): **[EvidenceReport on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencereport.html)** The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.
- [Create a new EvidenceReport](https://api-reference.oystehr.com/reference/post_evidencereport.md): **[EvidenceReport on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencereport.html)** The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts. The body should be a valid FHIR object for EvidenceReport. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`EvidenceReport`](https://www.hl7.org/fhir/r4b/EvidenceReport.html).
- [Search EvidenceReports](https://api-reference.oystehr.com/reference/post_evidencereport-search.md): **[EvidenceReport on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencereport.html)** The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.
- [Get EvidenceReport with identifier {identifier}](https://api-reference.oystehr.com/reference/get_evidencereport-identifier.md): **[EvidenceReport on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencereport.html)** The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.
- [Update EvidenceReport with identifier {identifier}](https://api-reference.oystehr.com/reference/put_evidencereport-identifier.md): **[EvidenceReport on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencereport.html)** The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts. The body should be a valid FHIR object for EvidenceReport. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`EvidenceReport`](https://www.hl7.org/fhir/r4b/EvidenceReport.html).
- [Patch EvidenceReport with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_evidencereport-identifier.md): **[EvidenceReport on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencereport.html)** The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts. The body should be a list of valid JSON patches for EvidenceReport. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete EvidenceReport with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_evidencereport-identifier.md): **[EvidenceReport on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencereport.html)** The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.
- [Get history of EvidenceReport with identifier {identifier}](https://api-reference.oystehr.com/reference/get_evidencereport-identifier-history.md): **[EvidenceReport on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencereport.html)** The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.
- [Get EvidenceReport with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_evidencereport-identifier-history-versionidentifier.md): **[EvidenceReport on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencereport.html)** The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.
- [Search EvidenceVariables](https://api-reference.oystehr.com/reference/get_evidencevariable.md): **[EvidenceVariable on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencevariable.html)** The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
- [Create a new EvidenceVariable](https://api-reference.oystehr.com/reference/post_evidencevariable.md): **[EvidenceVariable on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencevariable.html)** The EvidenceVariable resource describes an element that knowledge (Evidence) is about. The body should be a valid FHIR object for EvidenceVariable. Here is an example: ```json { "resourceType": "EvidenceVariable", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "draft", "characteristic": [ { "definitionCodeableConcept": { "text": "Diabetic patients over 65" } } ] } ``` You can reference the FHIR documentation to determine the format for [`EvidenceVariable`](https://www.hl7.org/fhir/r4b/EvidenceVariable.html).
- [Search EvidenceVariables](https://api-reference.oystehr.com/reference/post_evidencevariable-search.md): **[EvidenceVariable on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencevariable.html)** The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
- [Get EvidenceVariable with identifier {identifier}](https://api-reference.oystehr.com/reference/get_evidencevariable-identifier.md): **[EvidenceVariable on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencevariable.html)** The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
- [Update EvidenceVariable with identifier {identifier}](https://api-reference.oystehr.com/reference/put_evidencevariable-identifier.md): **[EvidenceVariable on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencevariable.html)** The EvidenceVariable resource describes an element that knowledge (Evidence) is about. The body should be a valid FHIR object for EvidenceVariable. Here is an example: ```json { "resourceType": "EvidenceVariable", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "draft", "characteristic": [ { "definitionCodeableConcept": { "text": "Diabetic patients over 65" } } ] } ``` You can reference the FHIR documentation to determine the format for [`EvidenceVariable`](https://www.hl7.org/fhir/r4b/EvidenceVariable.html).
- [Patch EvidenceVariable with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_evidencevariable-identifier.md): **[EvidenceVariable on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencevariable.html)** The EvidenceVariable resource describes an element that knowledge (Evidence) is about. The body should be a list of valid JSON patches for EvidenceVariable. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete EvidenceVariable with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_evidencevariable-identifier.md): **[EvidenceVariable on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencevariable.html)** The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
- [Get history of EvidenceVariable with identifier {identifier}](https://api-reference.oystehr.com/reference/get_evidencevariable-identifier-history.md): **[EvidenceVariable on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencevariable.html)** The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
- [Get EvidenceVariable with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_evidencevariable-identifier-history-versionidentifier.md): **[EvidenceVariable on the FHIR specification website.](https://www.hl7.org/fhir/r4b/evidencevariable.html)** The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
- [Search ExampleScenarios](https://api-reference.oystehr.com/reference/get_examplescenario.md): **[ExampleScenario on the FHIR specification website.](https://www.hl7.org/fhir/r4b/examplescenario.html)** Example of workflow instance.
- [Create a new ExampleScenario](https://api-reference.oystehr.com/reference/post_examplescenario.md): **[ExampleScenario on the FHIR specification website.](https://www.hl7.org/fhir/r4b/examplescenario.html)** Example of workflow instance. The body should be a valid FHIR object for ExampleScenario. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ExampleScenario`](https://www.hl7.org/fhir/r4b/ExampleScenario.html).
- [Search ExampleScenarios](https://api-reference.oystehr.com/reference/post_examplescenario-search.md): **[ExampleScenario on the FHIR specification website.](https://www.hl7.org/fhir/r4b/examplescenario.html)** Example of workflow instance.
- [Get ExampleScenario with identifier {identifier}](https://api-reference.oystehr.com/reference/get_examplescenario-identifier.md): **[ExampleScenario on the FHIR specification website.](https://www.hl7.org/fhir/r4b/examplescenario.html)** Example of workflow instance.
- [Update ExampleScenario with identifier {identifier}](https://api-reference.oystehr.com/reference/put_examplescenario-identifier.md): **[ExampleScenario on the FHIR specification website.](https://www.hl7.org/fhir/r4b/examplescenario.html)** Example of workflow instance. The body should be a valid FHIR object for ExampleScenario. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ExampleScenario`](https://www.hl7.org/fhir/r4b/ExampleScenario.html).
- [Patch ExampleScenario with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_examplescenario-identifier.md): **[ExampleScenario on the FHIR specification website.](https://www.hl7.org/fhir/r4b/examplescenario.html)** Example of workflow instance. The body should be a list of valid JSON patches for ExampleScenario. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ExampleScenario with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_examplescenario-identifier.md): **[ExampleScenario on the FHIR specification website.](https://www.hl7.org/fhir/r4b/examplescenario.html)** Example of workflow instance.
- [Get history of ExampleScenario with identifier {identifier}](https://api-reference.oystehr.com/reference/get_examplescenario-identifier-history.md): **[ExampleScenario on the FHIR specification website.](https://www.hl7.org/fhir/r4b/examplescenario.html)** Example of workflow instance.
- [Get ExampleScenario with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_examplescenario-identifier-history-versionidentifier.md): **[ExampleScenario on the FHIR specification website.](https://www.hl7.org/fhir/r4b/examplescenario.html)** Example of workflow instance.
- [Search ExplanationOfBenefits](https://api-reference.oystehr.com/reference/get_explanationofbenefit.md): **[ExplanationOfBenefit on the FHIR specification website.](https://www.hl7.org/fhir/r4b/explanationofbenefit.html)** This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
- [Create a new ExplanationOfBenefit](https://api-reference.oystehr.com/reference/post_explanationofbenefit.md): **[ExplanationOfBenefit on the FHIR specification website.](https://www.hl7.org/fhir/r4b/explanationofbenefit.html)** This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided. The body should be a valid FHIR object for ExplanationOfBenefit. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ExplanationOfBenefit`](https://www.hl7.org/fhir/r4b/ExplanationOfBenefit.html).
- [Search ExplanationOfBenefits](https://api-reference.oystehr.com/reference/post_explanationofbenefit-search.md): **[ExplanationOfBenefit on the FHIR specification website.](https://www.hl7.org/fhir/r4b/explanationofbenefit.html)** This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
- [Get ExplanationOfBenefit with identifier {identifier}](https://api-reference.oystehr.com/reference/get_explanationofbenefit-identifier.md): **[ExplanationOfBenefit on the FHIR specification website.](https://www.hl7.org/fhir/r4b/explanationofbenefit.html)** This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
- [Update ExplanationOfBenefit with identifier {identifier}](https://api-reference.oystehr.com/reference/put_explanationofbenefit-identifier.md): **[ExplanationOfBenefit on the FHIR specification website.](https://www.hl7.org/fhir/r4b/explanationofbenefit.html)** This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided. The body should be a valid FHIR object for ExplanationOfBenefit. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ExplanationOfBenefit`](https://www.hl7.org/fhir/r4b/ExplanationOfBenefit.html).
- [Patch ExplanationOfBenefit with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_explanationofbenefit-identifier.md): **[ExplanationOfBenefit on the FHIR specification website.](https://www.hl7.org/fhir/r4b/explanationofbenefit.html)** This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided. The body should be a list of valid JSON patches for ExplanationOfBenefit. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ExplanationOfBenefit with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_explanationofbenefit-identifier.md): **[ExplanationOfBenefit on the FHIR specification website.](https://www.hl7.org/fhir/r4b/explanationofbenefit.html)** This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
- [Get history of ExplanationOfBenefit with identifier {identifier}](https://api-reference.oystehr.com/reference/get_explanationofbenefit-identifier-history.md): **[ExplanationOfBenefit on the FHIR specification website.](https://www.hl7.org/fhir/r4b/explanationofbenefit.html)** This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
- [Get ExplanationOfBenefit with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_explanationofbenefit-identifier-history-versionidentifier.md): **[ExplanationOfBenefit on the FHIR specification website.](https://www.hl7.org/fhir/r4b/explanationofbenefit.html)** This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
- [Search FamilyMemberHistorys](https://api-reference.oystehr.com/reference/get_familymemberhistory.md): **[FamilyMemberHistory on the FHIR specification website.](https://www.hl7.org/fhir/r4b/familymemberhistory.html)** Significant health conditions for a person related to the patient relevant in the context of care for the patient.
- [Create a new FamilyMemberHistory](https://api-reference.oystehr.com/reference/post_familymemberhistory.md): **[FamilyMemberHistory on the FHIR specification website.](https://www.hl7.org/fhir/r4b/familymemberhistory.html)** Significant health conditions for a person related to the patient relevant in the context of care for the patient. The body should be a valid FHIR object for FamilyMemberHistory. Here is an example: ```json { "resourceType": "FamilyMemberHistory", "id": "father", "text": { "status": "generated", "div": "Father died of a heart attack aged 74
" }, "identifier": [ { "value": "12345" } ], "instantiatesUri": [ "http://example.org/family-member-history-questionnaire" ], "status": "completed", "patient": { "reference": "Patient/example", "display": "Peter Patient" }, "date": "2011-03-18", "relationship": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "FTH", "display": "father" } ] }, "sex": { "coding": [ { "system": "http://hl7.org/fhir/administrative-gender", "code": "male", "display": "Male" } ] }, "condition": [ { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "315619001", "display": "Myocardial Infarction" } ], "text": "Heart Attack" }, "contributedToDeath": true, "onsetAge": { "value": 74, "unit": "yr", "system": "http://unitsofmeasure.org", "code": "a" }, "note": [ { "text": "Was fishing at the time. At least he went doing someting he loved." } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`FamilyMemberHistory`](https://www.hl7.org/fhir/r4b/FamilyMemberHistory.html).
- [Search FamilyMemberHistorys](https://api-reference.oystehr.com/reference/post_familymemberhistory-search.md): **[FamilyMemberHistory on the FHIR specification website.](https://www.hl7.org/fhir/r4b/familymemberhistory.html)** Significant health conditions for a person related to the patient relevant in the context of care for the patient.
- [Get FamilyMemberHistory with identifier {identifier}](https://api-reference.oystehr.com/reference/get_familymemberhistory-identifier.md): **[FamilyMemberHistory on the FHIR specification website.](https://www.hl7.org/fhir/r4b/familymemberhistory.html)** Significant health conditions for a person related to the patient relevant in the context of care for the patient.
- [Update FamilyMemberHistory with identifier {identifier}](https://api-reference.oystehr.com/reference/put_familymemberhistory-identifier.md): **[FamilyMemberHistory on the FHIR specification website.](https://www.hl7.org/fhir/r4b/familymemberhistory.html)** Significant health conditions for a person related to the patient relevant in the context of care for the patient. The body should be a valid FHIR object for FamilyMemberHistory. Here is an example: ```json { "resourceType": "FamilyMemberHistory", "id": "father", "text": { "status": "generated", "div": "Father died of a heart attack aged 74
" }, "identifier": [ { "value": "12345" } ], "instantiatesUri": [ "http://example.org/family-member-history-questionnaire" ], "status": "completed", "patient": { "reference": "Patient/example", "display": "Peter Patient" }, "date": "2011-03-18", "relationship": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "FTH", "display": "father" } ] }, "sex": { "coding": [ { "system": "http://hl7.org/fhir/administrative-gender", "code": "male", "display": "Male" } ] }, "condition": [ { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "315619001", "display": "Myocardial Infarction" } ], "text": "Heart Attack" }, "contributedToDeath": true, "onsetAge": { "value": 74, "unit": "yr", "system": "http://unitsofmeasure.org", "code": "a" }, "note": [ { "text": "Was fishing at the time. At least he went doing someting he loved." } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`FamilyMemberHistory`](https://www.hl7.org/fhir/r4b/FamilyMemberHistory.html).
- [Patch FamilyMemberHistory with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_familymemberhistory-identifier.md): **[FamilyMemberHistory on the FHIR specification website.](https://www.hl7.org/fhir/r4b/familymemberhistory.html)** Significant health conditions for a person related to the patient relevant in the context of care for the patient. The body should be a list of valid JSON patches for FamilyMemberHistory. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete FamilyMemberHistory with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_familymemberhistory-identifier.md): **[FamilyMemberHistory on the FHIR specification website.](https://www.hl7.org/fhir/r4b/familymemberhistory.html)** Significant health conditions for a person related to the patient relevant in the context of care for the patient.
- [Get history of FamilyMemberHistory with identifier {identifier}](https://api-reference.oystehr.com/reference/get_familymemberhistory-identifier-history.md): **[FamilyMemberHistory on the FHIR specification website.](https://www.hl7.org/fhir/r4b/familymemberhistory.html)** Significant health conditions for a person related to the patient relevant in the context of care for the patient.
- [Get FamilyMemberHistory with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_familymemberhistory-identifier-history-versionidentifier.md): **[FamilyMemberHistory on the FHIR specification website.](https://www.hl7.org/fhir/r4b/familymemberhistory.html)** Significant health conditions for a person related to the patient relevant in the context of care for the patient.
- [Search Flags](https://api-reference.oystehr.com/reference/get_flag.md): **[Flag on the FHIR specification website.](https://www.hl7.org/fhir/r4b/flag.html)** Prospective warnings of potential issues when providing care to the patient.
- [Create a new Flag](https://api-reference.oystehr.com/reference/post_flag.md): **[Flag on the FHIR specification website.](https://www.hl7.org/fhir/r4b/flag.html)** Prospective warnings of potential issues when providing care to the patient. The body should be a valid FHIR object for Flag. Here is an example: ```json { "resourceType": "Flag", "id": "example-encounter", "text": { "status": "generated", "div": "Follow Infection Control Level 3 Protocol
" }, "status": "active", "category": [ { "coding": [ { "system": "http://example.org/local", "code": "infection", "display": "Infection Control Level" } ] } ], "code": { "coding": [ { "system": "http://example.org/local/if1", "code": "l3", "display": "Follow Level 3 Protocol" } ] }, "subject": { "reference": "Patient/example", "display": "Peter Patient" }, "encounter": { "reference": "Encounter/example" } } ``` You can reference the FHIR documentation to determine the format for [`Flag`](https://www.hl7.org/fhir/r4b/Flag.html).
- [Search Flags](https://api-reference.oystehr.com/reference/post_flag-search.md): **[Flag on the FHIR specification website.](https://www.hl7.org/fhir/r4b/flag.html)** Prospective warnings of potential issues when providing care to the patient.
- [Get Flag with identifier {identifier}](https://api-reference.oystehr.com/reference/get_flag-identifier.md): **[Flag on the FHIR specification website.](https://www.hl7.org/fhir/r4b/flag.html)** Prospective warnings of potential issues when providing care to the patient.
- [Update Flag with identifier {identifier}](https://api-reference.oystehr.com/reference/put_flag-identifier.md): **[Flag on the FHIR specification website.](https://www.hl7.org/fhir/r4b/flag.html)** Prospective warnings of potential issues when providing care to the patient. The body should be a valid FHIR object for Flag. Here is an example: ```json { "resourceType": "Flag", "id": "example-encounter", "text": { "status": "generated", "div": "Follow Infection Control Level 3 Protocol
" }, "status": "active", "category": [ { "coding": [ { "system": "http://example.org/local", "code": "infection", "display": "Infection Control Level" } ] } ], "code": { "coding": [ { "system": "http://example.org/local/if1", "code": "l3", "display": "Follow Level 3 Protocol" } ] }, "subject": { "reference": "Patient/example", "display": "Peter Patient" }, "encounter": { "reference": "Encounter/example" } } ``` You can reference the FHIR documentation to determine the format for [`Flag`](https://www.hl7.org/fhir/r4b/Flag.html).
- [Patch Flag with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_flag-identifier.md): **[Flag on the FHIR specification website.](https://www.hl7.org/fhir/r4b/flag.html)** Prospective warnings of potential issues when providing care to the patient. The body should be a list of valid JSON patches for Flag. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Flag with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_flag-identifier.md): **[Flag on the FHIR specification website.](https://www.hl7.org/fhir/r4b/flag.html)** Prospective warnings of potential issues when providing care to the patient.
- [Get history of Flag with identifier {identifier}](https://api-reference.oystehr.com/reference/get_flag-identifier-history.md): **[Flag on the FHIR specification website.](https://www.hl7.org/fhir/r4b/flag.html)** Prospective warnings of potential issues when providing care to the patient.
- [Get Flag with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_flag-identifier-history-versionidentifier.md): **[Flag on the FHIR specification website.](https://www.hl7.org/fhir/r4b/flag.html)** Prospective warnings of potential issues when providing care to the patient.
- [Search Goals](https://api-reference.oystehr.com/reference/get_goal.md): **[Goal on the FHIR specification website.](https://www.hl7.org/fhir/r4b/goal.html)** Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
- [Create a new Goal](https://api-reference.oystehr.com/reference/post_goal.md): **[Goal on the FHIR specification website.](https://www.hl7.org/fhir/r4b/goal.html)** Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc. The body should be a valid FHIR object for Goal. Here is an example: ```json { "resourceType": "Goal", "id": "example", "text": { "status": "additional", "div": "\n\t\t\t
A simple care goal for a patient to lose weight due to obesity.
\n\t\t
\n\t\t\t
A simple care goal for a patient to lose weight due to obesity.
\n\t\t
Generated Narrative with Details
id: example
url: http://h7.org/fhir/GraphDefinition/example
name: Document Generation Template
status: draft
date: 04/08/2015
publisher: FHIR Project
contact:
description: Specify to include list references when generating a document using the $document operation
start: Composition
link
path: Composition.section.entry
description: Link to List
target
type: List
Compartments
| - | Use | Code | Rule |
| * | requirement | Patient | identical |
Links
Generated Narrative with Details
id: example
url: http://h7.org/fhir/GraphDefinition/example
name: Document Generation Template
status: draft
date: 04/08/2015
publisher: FHIR Project
contact:
description: Specify to include list references when generating a document using the $document operation
start: Composition
link
path: Composition.section.entry
description: Link to List
target
type: List
Compartments
| - | Use | Code | Rule |
| * | requirement | Patient | identical |
Links
\n
Herd of 25 horses
\n
Gender: mixed
\n
Owner: John Smith
\n
\n
Herd of 25 horses
\n
Gender: mixed
\n
Owner: John Smith
\n
CT Chest. John Smith (MRN: 09236). Accession: W12342398. Performed: 2011-01-01. 3 series, 12 images.
" }, "identifier": [ { "system": "urn:dicom:uid", "value": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045" } ], "status": "available", "subject": { "reference": "Patient/dicom" }, "started": "2011-01-01T11:01:20+03:00", "numberOfSeries": 1, "numberOfInstances": 1, "series": [ { "uid": "2.16.124.113543.6003.2588828330.45298.17418.2723805630", "number": 3, "modality": { "system": "http://dicom.nema.org/resources/ontology/DCM", "code": "CT" }, "description": "CT Surview 180", "numberOfInstances": 1, "bodySite": { "system": "http://snomed.info/sct", "code": "67734004", "display": "Upper Trunk Structure" }, "instance": [ { "uid": "2.16.124.113543.6003.189642796.63084.16748.2599092903", "sopClass": { "system": "urn:ietf:rfc:3986", "code": "urn:oid:1.2.840.10008.5.1.4.1.1.2" }, "number": 1 } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`ImagingStudy`](https://www.hl7.org/fhir/r4b/ImagingStudy.html).
- [Search ImagingStudys](https://api-reference.oystehr.com/reference/post_imagingstudy-search.md): **[ImagingStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/imagingstudy.html)** Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
- [Get ImagingStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/get_imagingstudy-identifier.md): **[ImagingStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/imagingstudy.html)** Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
- [Update ImagingStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/put_imagingstudy-identifier.md): **[ImagingStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/imagingstudy.html)** Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities. The body should be a valid FHIR object for ImagingStudy. Here is an example: ```json { "resourceType": "ImagingStudy", "id": "example", "text": { "status": "generated", "div": "CT Chest. John Smith (MRN: 09236). Accession: W12342398. Performed: 2011-01-01. 3 series, 12 images.
" }, "identifier": [ { "system": "urn:dicom:uid", "value": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045" } ], "status": "available", "subject": { "reference": "Patient/dicom" }, "started": "2011-01-01T11:01:20+03:00", "numberOfSeries": 1, "numberOfInstances": 1, "series": [ { "uid": "2.16.124.113543.6003.2588828330.45298.17418.2723805630", "number": 3, "modality": { "system": "http://dicom.nema.org/resources/ontology/DCM", "code": "CT" }, "description": "CT Surview 180", "numberOfInstances": 1, "bodySite": { "system": "http://snomed.info/sct", "code": "67734004", "display": "Upper Trunk Structure" }, "instance": [ { "uid": "2.16.124.113543.6003.189642796.63084.16748.2599092903", "sopClass": { "system": "urn:ietf:rfc:3986", "code": "urn:oid:1.2.840.10008.5.1.4.1.1.2" }, "number": 1 } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`ImagingStudy`](https://www.hl7.org/fhir/r4b/ImagingStudy.html).
- [Patch ImagingStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_imagingstudy-identifier.md): **[ImagingStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/imagingstudy.html)** Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities. The body should be a list of valid JSON patches for ImagingStudy. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ImagingStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_imagingstudy-identifier.md): **[ImagingStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/imagingstudy.html)** Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
- [Get history of ImagingStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/get_imagingstudy-identifier-history.md): **[ImagingStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/imagingstudy.html)** Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
- [Get ImagingStudy with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_imagingstudy-identifier-history-versionidentifier.md): **[ImagingStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/imagingstudy.html)** Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
- [Search Immunizations](https://api-reference.oystehr.com/reference/get_immunization.md): **[Immunization on the FHIR specification website.](https://www.hl7.org/fhir/r4b/immunization.html)** Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
- [Create a new Immunization](https://api-reference.oystehr.com/reference/post_immunization.md): **[Immunization on the FHIR specification website.](https://www.hl7.org/fhir/r4b/immunization.html)** Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. The body should be a valid FHIR object for Immunization. Here is an example: ```json { "resourceType": "Immunization", "id": "historical", "text": { "status": "generated", "div": "Generated Narrative with Details
id: historical
identifier: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234
status: completed
vaccineCode: Influenza (Details : {urn:oid:1.2.36.1.2001.1005.17 code 'GNFLU' = 'Influenza)
patient: Patient/example
occurrence: January 2012
primarySource: false
reportOrigin: Written Record (Details : {http://terminology.hl7.org/CodeSystem/immunization-origin code 'record' = 'Written Record)
location: Location/1
note: Notes on adminstration of a historical vaccine
Generated Narrative with Details
id: historical
identifier: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234
status: completed
vaccineCode: Influenza (Details : {urn:oid:1.2.36.1.2001.1005.17 code 'GNFLU' = 'Influenza)
patient: Patient/example
occurrence: January 2012
primarySource: false
reportOrigin: Written Record (Details : {http://terminology.hl7.org/CodeSystem/immunization-origin code 'record' = 'Written Record)
location: Location/1
note: Notes on adminstration of a historical vaccine
Generated Narrative with Details
id: example
identifier: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234
status: completed
patient: Patient/example
date: 10/01/2013
authority: Organization/hl7
targetDisease: Gestational rubella syndrome (Details : {SNOMED CT code '1857005' = 'Gestational rubella syndrome)
immunizationEvent: Immunization/example
doseStatus: Valid (Details : {http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status code 'valid' = 'Valid', given as 'Valid'})
series: Vaccination Series 1
doseNumber: 1
seriesDoses: 3
Generated Narrative with Details
id: example
identifier: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234
status: completed
patient: Patient/example
date: 10/01/2013
authority: Organization/hl7
targetDisease: Gestational rubella syndrome (Details : {SNOMED CT code '1857005' = 'Gestational rubella syndrome)
immunizationEvent: Immunization/example
doseStatus: Valid (Details : {http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status code 'valid' = 'Valid', given as 'Valid'})
series: Vaccination Series 1
doseNumber: 1
seriesDoses: 3
Authored by Joginder Madra
" }, "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1235" } ], "patient": { "reference": "Patient/example" }, "date": "2015-02-09T11:04:15.817-05:00", "authority": { "reference": "Organization/hl7" }, "recommendation": [ { "targetDisease": { "coding": [ { "system": "http://snomed.info/sct", "code": "40468003" } ] }, "forecastStatus": { "text": "Not Complete" }, "dateCriterion": [ { "code": { "coding": [ { "system": "http://loinc.org", "code": "30981-5", "display": "Earliest date to give" } ] }, "value": "2015-12-01T00:00:00-05:00" }, { "code": { "coding": [ { "system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion", "code": "recommended", "display": "Recommended" } ] }, "value": "2015-12-01T00:00:00-05:00" }, { "code": { "coding": [ { "system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion", "code": "overdue", "display": "Past Due Date" } ] }, "value": "2016-12-28T00:00:00-05:00" } ], "description": "First sequence in protocol", "series": "Vaccination Series 1", "doseNumberPositiveInt": 1, "seriesDosesPositiveInt": 3, "supportingImmunization": [ { "reference": "Immunization/example" } ], "supportingPatientInformation": [ { "reference": "Observation/example" } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`ImmunizationRecommendation`](https://www.hl7.org/fhir/r4b/ImmunizationRecommendation.html).
- [Search ImmunizationRecommendations](https://api-reference.oystehr.com/reference/post_immunizationrecommendation-search.md): **[ImmunizationRecommendation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/immunizationrecommendation.html)** A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
- [Get ImmunizationRecommendation with identifier {identifier}](https://api-reference.oystehr.com/reference/get_immunizationrecommendation-identifier.md): **[ImmunizationRecommendation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/immunizationrecommendation.html)** A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
- [Update ImmunizationRecommendation with identifier {identifier}](https://api-reference.oystehr.com/reference/put_immunizationrecommendation-identifier.md): **[ImmunizationRecommendation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/immunizationrecommendation.html)** A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification. The body should be a valid FHIR object for ImmunizationRecommendation. Here is an example: ```json { "resourceType": "ImmunizationRecommendation", "id": "example", "text": { "status": "generated", "div": "Authored by Joginder Madra
" }, "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1235" } ], "patient": { "reference": "Patient/example" }, "date": "2015-02-09T11:04:15.817-05:00", "authority": { "reference": "Organization/hl7" }, "recommendation": [ { "targetDisease": { "coding": [ { "system": "http://snomed.info/sct", "code": "40468003" } ] }, "forecastStatus": { "text": "Not Complete" }, "dateCriterion": [ { "code": { "coding": [ { "system": "http://loinc.org", "code": "30981-5", "display": "Earliest date to give" } ] }, "value": "2015-12-01T00:00:00-05:00" }, { "code": { "coding": [ { "system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion", "code": "recommended", "display": "Recommended" } ] }, "value": "2015-12-01T00:00:00-05:00" }, { "code": { "coding": [ { "system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion", "code": "overdue", "display": "Past Due Date" } ] }, "value": "2016-12-28T00:00:00-05:00" } ], "description": "First sequence in protocol", "series": "Vaccination Series 1", "doseNumberPositiveInt": 1, "seriesDosesPositiveInt": 3, "supportingImmunization": [ { "reference": "Immunization/example" } ], "supportingPatientInformation": [ { "reference": "Observation/example" } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`ImmunizationRecommendation`](https://www.hl7.org/fhir/r4b/ImmunizationRecommendation.html).
- [Patch ImmunizationRecommendation with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_immunizationrecommendation-identifier.md): **[ImmunizationRecommendation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/immunizationrecommendation.html)** A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification. The body should be a list of valid JSON patches for ImmunizationRecommendation. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ImmunizationRecommendation with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_immunizationrecommendation-identifier.md): **[ImmunizationRecommendation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/immunizationrecommendation.html)** A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
- [Get history of ImmunizationRecommendation with identifier {identifier}](https://api-reference.oystehr.com/reference/get_immunizationrecommendation-identifier-history.md): **[ImmunizationRecommendation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/immunizationrecommendation.html)** A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
- [Get ImmunizationRecommendation with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_immunizationrecommendation-identifier-history-versionidentifier.md): **[ImmunizationRecommendation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/immunizationrecommendation.html)** A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
- [Search ImplementationGuides](https://api-reference.oystehr.com/reference/get_implementationguide.md): **[ImplementationGuide on the FHIR specification website.](https://www.hl7.org/fhir/r4b/implementationguide.html)** A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
- [Create a new ImplementationGuide](https://api-reference.oystehr.com/reference/post_implementationguide.md): **[ImplementationGuide on the FHIR specification website.](https://www.hl7.org/fhir/r4b/implementationguide.html)** A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts. The body should be a valid FHIR object for ImplementationGuide. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ImplementationGuide`](https://www.hl7.org/fhir/r4b/ImplementationGuide.html).
- [Search ImplementationGuides](https://api-reference.oystehr.com/reference/post_implementationguide-search.md): **[ImplementationGuide on the FHIR specification website.](https://www.hl7.org/fhir/r4b/implementationguide.html)** A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
- [Get ImplementationGuide with identifier {identifier}](https://api-reference.oystehr.com/reference/get_implementationguide-identifier.md): **[ImplementationGuide on the FHIR specification website.](https://www.hl7.org/fhir/r4b/implementationguide.html)** A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
- [Update ImplementationGuide with identifier {identifier}](https://api-reference.oystehr.com/reference/put_implementationguide-identifier.md): **[ImplementationGuide on the FHIR specification website.](https://www.hl7.org/fhir/r4b/implementationguide.html)** A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts. The body should be a valid FHIR object for ImplementationGuide. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ImplementationGuide`](https://www.hl7.org/fhir/r4b/ImplementationGuide.html).
- [Patch ImplementationGuide with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_implementationguide-identifier.md): **[ImplementationGuide on the FHIR specification website.](https://www.hl7.org/fhir/r4b/implementationguide.html)** A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts. The body should be a list of valid JSON patches for ImplementationGuide. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ImplementationGuide with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_implementationguide-identifier.md): **[ImplementationGuide on the FHIR specification website.](https://www.hl7.org/fhir/r4b/implementationguide.html)** A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
- [Get history of ImplementationGuide with identifier {identifier}](https://api-reference.oystehr.com/reference/get_implementationguide-identifier-history.md): **[ImplementationGuide on the FHIR specification website.](https://www.hl7.org/fhir/r4b/implementationguide.html)** A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
- [Get ImplementationGuide with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_implementationguide-identifier-history-versionidentifier.md): **[ImplementationGuide on the FHIR specification website.](https://www.hl7.org/fhir/r4b/implementationguide.html)** A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
- [Search Ingredients](https://api-reference.oystehr.com/reference/get_ingredient.md): **[Ingredient on the FHIR specification website.](https://www.hl7.org/fhir/r4b/ingredient.html)** An ingredient of a manufactured item or pharmaceutical product.
- [Create a new Ingredient](https://api-reference.oystehr.com/reference/post_ingredient.md): **[Ingredient on the FHIR specification website.](https://www.hl7.org/fhir/r4b/ingredient.html)** An ingredient of a manufactured item or pharmaceutical product. The body should be a valid FHIR object for Ingredient. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`Ingredient`](https://www.hl7.org/fhir/r4b/Ingredient.html).
- [Search Ingredients](https://api-reference.oystehr.com/reference/post_ingredient-search.md): **[Ingredient on the FHIR specification website.](https://www.hl7.org/fhir/r4b/ingredient.html)** An ingredient of a manufactured item or pharmaceutical product.
- [Get Ingredient with identifier {identifier}](https://api-reference.oystehr.com/reference/get_ingredient-identifier.md): **[Ingredient on the FHIR specification website.](https://www.hl7.org/fhir/r4b/ingredient.html)** An ingredient of a manufactured item or pharmaceutical product.
- [Update Ingredient with identifier {identifier}](https://api-reference.oystehr.com/reference/put_ingredient-identifier.md): **[Ingredient on the FHIR specification website.](https://www.hl7.org/fhir/r4b/ingredient.html)** An ingredient of a manufactured item or pharmaceutical product. The body should be a valid FHIR object for Ingredient. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`Ingredient`](https://www.hl7.org/fhir/r4b/Ingredient.html).
- [Patch Ingredient with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_ingredient-identifier.md): **[Ingredient on the FHIR specification website.](https://www.hl7.org/fhir/r4b/ingredient.html)** An ingredient of a manufactured item or pharmaceutical product. The body should be a list of valid JSON patches for Ingredient. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Ingredient with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_ingredient-identifier.md): **[Ingredient on the FHIR specification website.](https://www.hl7.org/fhir/r4b/ingredient.html)** An ingredient of a manufactured item or pharmaceutical product.
- [Get history of Ingredient with identifier {identifier}](https://api-reference.oystehr.com/reference/get_ingredient-identifier-history.md): **[Ingredient on the FHIR specification website.](https://www.hl7.org/fhir/r4b/ingredient.html)** An ingredient of a manufactured item or pharmaceutical product.
- [Get Ingredient with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_ingredient-identifier-history-versionidentifier.md): **[Ingredient on the FHIR specification website.](https://www.hl7.org/fhir/r4b/ingredient.html)** An ingredient of a manufactured item or pharmaceutical product.
- [Search InsurancePlans](https://api-reference.oystehr.com/reference/get_insuranceplan.md): **[InsurancePlan on the FHIR specification website.](https://www.hl7.org/fhir/r4b/insuranceplan.html)** Details of a Health Insurance product/plan provided by an organization.
- [Create a new InsurancePlan](https://api-reference.oystehr.com/reference/post_insuranceplan.md): **[InsurancePlan on the FHIR specification website.](https://www.hl7.org/fhir/r4b/insuranceplan.html)** Details of a Health Insurance product/plan provided by an organization. The body should be a valid FHIR object for InsurancePlan. Here is an example: ```json { "resourceType": "InsurancePlan", "id": "example", "text": { "status": "generated", "div": "Generated Narrative with Details
id: example
name: foo
Generated Narrative with Details
id: example
name: foo
Example of Invoice
" }, "identifier": [ { "system": "http://myHospital.org/Invoices", "value": "654321" } ], "status": "issued", "subject": { "reference": "Patient/example" }, "date": "2017-01-25T08:00:00+01:00", "participant": [ { "role": { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] }, "actor": { "reference": "Practitioner/example" } } ], "issuer": { "identifier": { "system": "http://myhospital/NamingSystem/departments", "value": "CARD_INTERMEDIATE_CARE" } }, "account": { "reference": "Account/example" }, "totalNet": { "value": 40, "currency": "EUR" }, "totalGross": { "value": 48, "currency": "EUR" } } ``` You can reference the FHIR documentation to determine the format for [`Invoice`](https://www.hl7.org/fhir/r4b/Invoice.html).
- [Search Invoices](https://api-reference.oystehr.com/reference/post_invoice-search.md): **[Invoice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/invoice.html)** Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
- [Get Invoice with identifier {identifier}](https://api-reference.oystehr.com/reference/get_invoice-identifier.md): **[Invoice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/invoice.html)** Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
- [Update Invoice with identifier {identifier}](https://api-reference.oystehr.com/reference/put_invoice-identifier.md): **[Invoice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/invoice.html)** Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. The body should be a valid FHIR object for Invoice. Here is an example: ```json { "resourceType": "Invoice", "id": "example", "text": { "status": "generated", "div": "Example of Invoice
" }, "identifier": [ { "system": "http://myHospital.org/Invoices", "value": "654321" } ], "status": "issued", "subject": { "reference": "Patient/example" }, "date": "2017-01-25T08:00:00+01:00", "participant": [ { "role": { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] }, "actor": { "reference": "Practitioner/example" } } ], "issuer": { "identifier": { "system": "http://myhospital/NamingSystem/departments", "value": "CARD_INTERMEDIATE_CARE" } }, "account": { "reference": "Account/example" }, "totalNet": { "value": 40, "currency": "EUR" }, "totalGross": { "value": 48, "currency": "EUR" } } ``` You can reference the FHIR documentation to determine the format for [`Invoice`](https://www.hl7.org/fhir/r4b/Invoice.html).
- [Patch Invoice with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_invoice-identifier.md): **[Invoice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/invoice.html)** Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. The body should be a list of valid JSON patches for Invoice. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Invoice with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_invoice-identifier.md): **[Invoice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/invoice.html)** Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
- [Get history of Invoice with identifier {identifier}](https://api-reference.oystehr.com/reference/get_invoice-identifier-history.md): **[Invoice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/invoice.html)** Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
- [Get Invoice with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_invoice-identifier-history-versionidentifier.md): **[Invoice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/invoice.html)** Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
- [Search Librarys](https://api-reference.oystehr.com/reference/get_library.md): **[Library on the FHIR specification website.](https://www.hl7.org/fhir/r4b/library.html)** The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
- [Create a new Library](https://api-reference.oystehr.com/reference/post_library.md): **[Library on the FHIR specification website.](https://www.hl7.org/fhir/r4b/library.html)** The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets. The body should be a valid FHIR object for Library. Here is an example: ```json { "resourceType": "Library", "id": "composition-example", "text": { "status": "generated", "div": "Example of a library used as a composition of other artifacts.\n
" }, "identifier": [ { "use": "official", "system": "http://example.org", "value": "Zika Artifacts" } ], "version": "1.0.0", "title": "Zika Artifacts", "status": "draft", "type": { "coding": [ { "code": "asset-collection" } ] }, "date": "2017-03-10", "description": "Artifacts required for implementation of Zika Virus Management", "topic": [ { "text": "Zika Virus Management" } ], "relatedArtifact": [ { "type": "composed-of", "resource": "ActivityDefinition/administer-zika-virus-exposure-assessment" }, { "type": "composed-of", "resource": "ActivityDefinition/order-serum-zika-dengue-virus-igm" }, { "type": "composed-of", "resource": "ActivityDefinition/provide-mosquito-prevention-advice" }, { "type": "composed-of", "resource": "Library/zika-virus-intervention-logic" }, { "type": "composed-of", "resource": "PlanDefinition/zika-virus-intervention" }, { "type": "composed-of", "resource": "Questionnaire/zika-virus-exposure-assessment" }, { "type": "derived-from", "url": "https://www.cdc.gov/mmwr/volumes/65/wr/mm6539e1.htm?s_cid=mm6539e1_w" } ] } ``` You can reference the FHIR documentation to determine the format for [`Library`](https://www.hl7.org/fhir/r4b/Library.html).
- [Search Librarys](https://api-reference.oystehr.com/reference/post_library-search.md): **[Library on the FHIR specification website.](https://www.hl7.org/fhir/r4b/library.html)** The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
- [Get Library with identifier {identifier}](https://api-reference.oystehr.com/reference/get_library-identifier.md): **[Library on the FHIR specification website.](https://www.hl7.org/fhir/r4b/library.html)** The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
- [Update Library with identifier {identifier}](https://api-reference.oystehr.com/reference/put_library-identifier.md): **[Library on the FHIR specification website.](https://www.hl7.org/fhir/r4b/library.html)** The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets. The body should be a valid FHIR object for Library. Here is an example: ```json { "resourceType": "Library", "id": "composition-example", "text": { "status": "generated", "div": "Example of a library used as a composition of other artifacts.\n
" }, "identifier": [ { "use": "official", "system": "http://example.org", "value": "Zika Artifacts" } ], "version": "1.0.0", "title": "Zika Artifacts", "status": "draft", "type": { "coding": [ { "code": "asset-collection" } ] }, "date": "2017-03-10", "description": "Artifacts required for implementation of Zika Virus Management", "topic": [ { "text": "Zika Virus Management" } ], "relatedArtifact": [ { "type": "composed-of", "resource": "ActivityDefinition/administer-zika-virus-exposure-assessment" }, { "type": "composed-of", "resource": "ActivityDefinition/order-serum-zika-dengue-virus-igm" }, { "type": "composed-of", "resource": "ActivityDefinition/provide-mosquito-prevention-advice" }, { "type": "composed-of", "resource": "Library/zika-virus-intervention-logic" }, { "type": "composed-of", "resource": "PlanDefinition/zika-virus-intervention" }, { "type": "composed-of", "resource": "Questionnaire/zika-virus-exposure-assessment" }, { "type": "derived-from", "url": "https://www.cdc.gov/mmwr/volumes/65/wr/mm6539e1.htm?s_cid=mm6539e1_w" } ] } ``` You can reference the FHIR documentation to determine the format for [`Library`](https://www.hl7.org/fhir/r4b/Library.html).
- [Patch Library with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_library-identifier.md): **[Library on the FHIR specification website.](https://www.hl7.org/fhir/r4b/library.html)** The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets. The body should be a list of valid JSON patches for Library. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Library with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_library-identifier.md): **[Library on the FHIR specification website.](https://www.hl7.org/fhir/r4b/library.html)** The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
- [Get history of Library with identifier {identifier}](https://api-reference.oystehr.com/reference/get_library-identifier-history.md): **[Library on the FHIR specification website.](https://www.hl7.org/fhir/r4b/library.html)** The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
- [Get Library with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_library-identifier-history-versionidentifier.md): **[Library on the FHIR specification website.](https://www.hl7.org/fhir/r4b/library.html)** The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
- [Search Linkages](https://api-reference.oystehr.com/reference/get_linkage.md): **[Linkage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/linkage.html)** Identifies two or more records (resource instances) that refer to the same real-world "occurrence".
- [Create a new Linkage](https://api-reference.oystehr.com/reference/post_linkage.md): **[Linkage on the FHIR specification website.](https://www.hl7.org/fhir/r4b/linkage.html)** Identifies two or more records (resource instances) that refer to the same real-world "occurrence". The body should be a valid FHIR object for Linkage. Here is an example: ```json { "resourceType": "Linkage", "id": "example", "text": { "status": "generated", "div": "\n
Source: Condition/example - Severe burn of left ear (Date: 24-May 2012)
\n
Alternate: Condition/condition-example - Severe burn of left ear (Date: 24-May 2012)
\n
\n
Source: Condition/example - Severe burn of left ear (Date: 24-May 2012)
\n
Alternate: Condition/condition-example - Severe burn of left ear (Date: 24-May 2012)
\n
\n
Patient Peter Chalmers, DOB = Dec 25, 1974, MRN = 12345 (Acme Healthcare) has the following allergies
\n
\n - cashew nut allergenic extract Injectable Product (High)
\n - Allergenic extract, penicillin (high)
\n
\n
\n
Patient Peter Chalmers, DOB = Dec 25, 1974, MRN = 12345 (Acme Healthcare) has the following allergies
\n
\n - cashew nut allergenic extract Injectable Product (High)
\n - Allergenic extract, penicillin (high)
\n
\n
Burgers UMC, South Wing, second floor
" }, "identifier": [ { "value": "B1-S.F2" } ], "status": "active", "name": "South Wing, second floor", "alias": [ "BU MC, SW, F2", "Burgers University Medical Center, South Wing, second floor" ], "description": "Second floor of the Old South Wing, formerly in use by Psychiatry", "mode": "instance", "telecom": [ { "system": "phone", "value": "2328", "use": "work" }, { "system": "fax", "value": "2329", "use": "work" }, { "system": "email", "value": "second wing admissions" }, { "system": "url", "value": "http://sampleorg.com/southwing", "use": "work" } ], "address": { "use": "work", "line": [ "Galapagosweg 91, Building A" ], "city": "Den Burg", "postalCode": "9105 PZ", "country": "NLD" }, "physicalType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "code": "wi", "display": "Wing" } ] }, "position": { "longitude": -83.6945691, "latitude": 42.25475478, "altitude": 0 }, "managingOrganization": { "reference": "Organization/f001" }, "endpoint": [ { "reference": "Endpoint/example" } ] } ``` You can reference the FHIR documentation to determine the format for [`Location`](https://www.hl7.org/fhir/r4b/Location.html).
- [Search Locations](https://api-reference.oystehr.com/reference/post_location-search.md): **[Location on the FHIR specification website.](https://www.hl7.org/fhir/r4b/location.html)** Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
- [Get Location with identifier {identifier}](https://api-reference.oystehr.com/reference/get_location-identifier.md): **[Location on the FHIR specification website.](https://www.hl7.org/fhir/r4b/location.html)** Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
- [Update Location with identifier {identifier}](https://api-reference.oystehr.com/reference/put_location-identifier.md): **[Location on the FHIR specification website.](https://www.hl7.org/fhir/r4b/location.html)** Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. The body should be a valid FHIR object for Location. Here is an example: ```json { "resourceType": "Location", "id": "1", "text": { "status": "generated", "div": "Burgers UMC, South Wing, second floor
" }, "identifier": [ { "value": "B1-S.F2" } ], "status": "active", "name": "South Wing, second floor", "alias": [ "BU MC, SW, F2", "Burgers University Medical Center, South Wing, second floor" ], "description": "Second floor of the Old South Wing, formerly in use by Psychiatry", "mode": "instance", "telecom": [ { "system": "phone", "value": "2328", "use": "work" }, { "system": "fax", "value": "2329", "use": "work" }, { "system": "email", "value": "second wing admissions" }, { "system": "url", "value": "http://sampleorg.com/southwing", "use": "work" } ], "address": { "use": "work", "line": [ "Galapagosweg 91, Building A" ], "city": "Den Burg", "postalCode": "9105 PZ", "country": "NLD" }, "physicalType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/location-physical-type", "code": "wi", "display": "Wing" } ] }, "position": { "longitude": -83.6945691, "latitude": 42.25475478, "altitude": 0 }, "managingOrganization": { "reference": "Organization/f001" }, "endpoint": [ { "reference": "Endpoint/example" } ] } ``` You can reference the FHIR documentation to determine the format for [`Location`](https://www.hl7.org/fhir/r4b/Location.html).
- [Patch Location with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_location-identifier.md): **[Location on the FHIR specification website.](https://www.hl7.org/fhir/r4b/location.html)** Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. The body should be a list of valid JSON patches for Location. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Location with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_location-identifier.md): **[Location on the FHIR specification website.](https://www.hl7.org/fhir/r4b/location.html)** Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
- [Get history of Location with identifier {identifier}](https://api-reference.oystehr.com/reference/get_location-identifier-history.md): **[Location on the FHIR specification website.](https://www.hl7.org/fhir/r4b/location.html)** Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
- [Get Location with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_location-identifier-history-versionidentifier.md): **[Location on the FHIR specification website.](https://www.hl7.org/fhir/r4b/location.html)** Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
- [Search ManufacturedItemDefinitions](https://api-reference.oystehr.com/reference/get_manufactureditemdefinition.md): **[ManufacturedItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/manufactureditemdefinition.html)** The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.
- [Create a new ManufacturedItemDefinition](https://api-reference.oystehr.com/reference/post_manufactureditemdefinition.md): **[ManufacturedItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/manufactureditemdefinition.html)** The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product. The body should be a valid FHIR object for ManufacturedItemDefinition. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ManufacturedItemDefinition`](https://www.hl7.org/fhir/r4b/ManufacturedItemDefinition.html).
- [Search ManufacturedItemDefinitions](https://api-reference.oystehr.com/reference/post_manufactureditemdefinition-search.md): **[ManufacturedItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/manufactureditemdefinition.html)** The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.
- [Get ManufacturedItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_manufactureditemdefinition-identifier.md): **[ManufacturedItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/manufactureditemdefinition.html)** The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.
- [Update ManufacturedItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_manufactureditemdefinition-identifier.md): **[ManufacturedItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/manufactureditemdefinition.html)** The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product. The body should be a valid FHIR object for ManufacturedItemDefinition. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`ManufacturedItemDefinition`](https://www.hl7.org/fhir/r4b/ManufacturedItemDefinition.html).
- [Patch ManufacturedItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_manufactureditemdefinition-identifier.md): **[ManufacturedItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/manufactureditemdefinition.html)** The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product. The body should be a list of valid JSON patches for ManufacturedItemDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ManufacturedItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_manufactureditemdefinition-identifier.md): **[ManufacturedItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/manufactureditemdefinition.html)** The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.
- [Get history of ManufacturedItemDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_manufactureditemdefinition-identifier-history.md): **[ManufacturedItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/manufactureditemdefinition.html)** The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.
- [Get ManufacturedItemDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_manufactureditemdefinition-identifier-history-versionidentifier.md): **[ManufacturedItemDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/manufactureditemdefinition.html)** The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.
- [Search Measures](https://api-reference.oystehr.com/reference/get_measure.md): **[Measure on the FHIR specification website.](https://www.hl7.org/fhir/r4b/measure.html)** The Measure resource provides the definition of a quality measure.
- [Create a new Measure](https://api-reference.oystehr.com/reference/post_measure.md): **[Measure on the FHIR specification website.](https://www.hl7.org/fhir/r4b/measure.html)** The Measure resource provides the definition of a quality measure. The body should be a valid FHIR object for Measure. Here is an example: ```json { "resourceType": "Measure", "id": "component-a-example", "text": { "status": "generated", "div": "Screening for Alcohol Misuse\n
This measure example is used to illustrate how a composite measure can be constructured. This measure is one component of the composite measure.
Screening for Alcohol Misuse\n
This measure example is used to illustrate how a composite measure can be constructured. This measure is one component of the composite measure.
\n Ultrasound Image on patient "James Chalmers":
\n
![\"WADO](\"http://imaging.acme.com/wado/server?requestType=WADO&contentType=application%2Fdicom&studyUid=1.2.840.113619.2.21.848.34082.0.538976288.3&seriesUid=1.2.840.113619.2.21.3408.700.0.757923840.3.0&objectUid=1.2.840.11361907579238403408700.3.1.04.19970327150033\")
\n\n
\n Ultrasound Image on patient "James Chalmers":
\n
\n\n
Generated Narrative with Details
id: med0303
contained:
code: Alemtuzumab 10mg/ml (Lemtrada) (Details : {RxNorm code '1594660' = 'alemtuzumab 10 MG/ML [Lemtrada]', given as 'Alemtuzumab 10mg/ml (Lemtrada)'})
manufacturer: id: org6; name: Genzyme
form: Injection solution (qualifier vallue) (Details : {SNOMED CT code '385219001' = 'Injection solution', given as 'Injection solution (qualifier vallue)'})
Ingredients
| - | Item[x] | Strength |
| * | Alemtuzamab (substance) (Details : {SNOMED CT code '129472003' = 'Alemtuzumab', given as 'Alemtuzamab (substance)'}) | 12 mg (Details: UCUM code mg = 'mg')/1.2 mL (Details: UCUM code mL = 'mL') |
Batches
| - | LotNumber | ExpirationDate |
| * | 9494788 | 22/05/2017 |
Generated Narrative with Details
id: med0303
contained:
code: Alemtuzumab 10mg/ml (Lemtrada) (Details : {RxNorm code '1594660' = 'alemtuzumab 10 MG/ML [Lemtrada]', given as 'Alemtuzumab 10mg/ml (Lemtrada)'})
manufacturer: id: org6; name: Genzyme
form: Injection solution (qualifier vallue) (Details : {SNOMED CT code '385219001' = 'Injection solution', given as 'Injection solution (qualifier vallue)'})
Ingredients
| - | Item[x] | Strength |
| * | Alemtuzamab (substance) (Details : {SNOMED CT code '129472003' = 'Alemtuzumab', given as 'Alemtuzamab (substance)'}) | 12 mg (Details: UCUM code mg = 'mg')/1.2 mL (Details: UCUM code mL = 'mL') |
Batches
| - | LotNumber | ExpirationDate |
| * | 9494788 | 22/05/2017 |
Generated Narrative with Details
id: medadmin0308
status: completed
medication: Lantus 100 unit/ml injectable solution (Details : {RxNorm code '285018' = 'Lantus 100 UNT/ML Injectable Solution', given as 'Lantus 100 unit/ml injectable solution'})
subject: Donald Duck
effective: 15/01/2015 4:30:00 AM --> 15/01/2015 2:30:00 PM
Performers
request: MedicationRequest/medrx0320
Dosages
| - | Text | Route | Dose |
| * | 20 Units SC before breakfast | Subcutaneous (qualifier value) (Details : {SNOMED CT code '263887005' = 'Subcutaneous', given as 'Subcutaneous (qualifier value)'}) | 20 U (Details: UCUM code U = 'U') |
Generated Narrative with Details
id: medadmin0308
status: completed
medication: Lantus 100 unit/ml injectable solution (Details : {RxNorm code '285018' = 'Lantus 100 UNT/ML Injectable Solution', given as 'Lantus 100 unit/ml injectable solution'})
subject: Donald Duck
effective: 15/01/2015 4:30:00 AM --> 15/01/2015 2:30:00 PM
Performers
request: MedicationRequest/medrx0320
Dosages
| - | Text | Route | Dose |
| * | 20 Units SC before breakfast | Subcutaneous (qualifier value) (Details : {SNOMED CT code '263887005' = 'Subcutaneous', given as 'Subcutaneous (qualifier value)'}) | 20 U (Details: UCUM code U = 'U') |
Generated Narrative with Details
id: meddisp008
contained:
status: completed
medication: id: medexample015; Capecitabine 500mg oral tablet (Xeloda) (Details : {RxNorm code '213293' = 'Xeloda 500 MG Oral Tablet', given as 'Capecitabine 500mg oral tablet (Xeloda)'})
subject: Donald Duck
Performers
authorizingPrescription: MedicationRequest/medrx0309
dosageInstruction:
Generated Narrative with Details
id: meddisp008
contained:
status: completed
medication: id: medexample015; Capecitabine 500mg oral tablet (Xeloda) (Details : {RxNorm code '213293' = 'Xeloda 500 MG Oral Tablet', given as 'Capecitabine 500mg oral tablet (Xeloda)'})
subject: Donald Duck
Performers
authorizingPrescription: MedicationRequest/medrx0309
dosageInstruction:
Generated Narrative with Details
id: example
contained:
code: Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE) (Details : {http://hl7.org/fhir/sid/ndc code '0069-2587-10' = 'n/a', given as 'Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)'})
status: active
manufacturer: id: org4; name: Pfizer Laboratories Div Pfizer Inc
doseForm: Injection Solution (qualifier value) (Details : {SNOMED CT code '385219001' = 'Injection solution', given as 'Injection Solution (qualifier value)'})
amount: 50 mg/ml
synonym: Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)
Generated Narrative with Details
id: example
contained:
code: Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE) (Details : {http://hl7.org/fhir/sid/ndc code '0069-2587-10' = 'n/a', given as 'Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)'})
status: active
manufacturer: id: org4; name: Pfizer Laboratories Div Pfizer Inc
doseForm: Injection Solution (qualifier value) (Details : {SNOMED CT code '385219001' = 'Injection solution', given as 'Injection Solution (qualifier value)'})
amount: 50 mg/ml
synonym: Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)
Generated Narrative with Details
id: medrx002
identifier: 12345 (OFFICIAL)
status: active
intent: order
medication: prescribed medication
subject: Donald Duck
encounter: encounter that leads to this prescription
authoredOn: 01/03/2015
requester: Patrick Pump
reasonCode: Essential hypertension (disorder) (Details : {SNOMED CT code '59621000' = 'Essential hypertension', given as 'Essential hypertension (disorder)'})
dosageInstruction:
Generated Narrative with Details
id: medrx002
identifier: 12345 (OFFICIAL)
status: active
intent: order
medication: prescribed medication
subject: Donald Duck
encounter: encounter that leads to this prescription
authoredOn: 01/03/2015
requester: Patrick Pump
reasonCode: Essential hypertension (disorder) (Details : {SNOMED CT code '59621000' = 'Essential hypertension', given as 'Essential hypertension (disorder)'})
dosageInstruction:
Generated Narrative with Details
id: example003
status: active
medication: Little Pink Pill for water retention (Details )
subject: Donald Duck
effective: 01/02/2014
dateAsserted: 22/02/2014
informationSource: Donald Duck
reasonReference: Observation/blood-pressure
note: Patient cannot remember the name of the tablet, but takes it every day in the morning for water retention
dosage:
Generated Narrative with Details
id: example003
status: active
medication: Little Pink Pill for water retention (Details )
subject: Donald Duck
effective: 01/02/2014
dateAsserted: 22/02/2014
informationSource: Donald Duck
reasonReference: Observation/blood-pressure
note: Patient cannot remember the name of the tablet, but takes it every day in the morning for water retention
dosage:
Message definition base example
" }, "url": "http://hl7.org/fhir/MessageDefinition/example", "name": "EXAMPLE", "title": "Message definition base example", "status": "draft", "experimental": true, "date": "2016-11-09", "publisher": "Health Level Seven, Int'l", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org" } ] } ], "purpose": "Defines a base example for other MessageDefinition instances.", "eventCoding": { "system": "http://example.org/fhir/message-events", "code": "admin-notify" }, "category": "notification" } ``` You can reference the FHIR documentation to determine the format for [`MessageDefinition`](https://www.hl7.org/fhir/r4b/MessageDefinition.html).
- [Search MessageDefinitions](https://api-reference.oystehr.com/reference/post_messagedefinition-search.md): **[MessageDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/messagedefinition.html)** Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
- [Get MessageDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_messagedefinition-identifier.md): **[MessageDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/messagedefinition.html)** Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
- [Update MessageDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_messagedefinition-identifier.md): **[MessageDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/messagedefinition.html)** Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted. The body should be a valid FHIR object for MessageDefinition. Here is an example: ```json { "resourceType": "MessageDefinition", "id": "example", "text": { "status": "generated", "div": "Message definition base example
" }, "url": "http://hl7.org/fhir/MessageDefinition/example", "name": "EXAMPLE", "title": "Message definition base example", "status": "draft", "experimental": true, "date": "2016-11-09", "publisher": "Health Level Seven, Int'l", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org" } ] } ], "purpose": "Defines a base example for other MessageDefinition instances.", "eventCoding": { "system": "http://example.org/fhir/message-events", "code": "admin-notify" }, "category": "notification" } ``` You can reference the FHIR documentation to determine the format for [`MessageDefinition`](https://www.hl7.org/fhir/r4b/MessageDefinition.html).
- [Patch MessageDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_messagedefinition-identifier.md): **[MessageDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/messagedefinition.html)** Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted. The body should be a list of valid JSON patches for MessageDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete MessageDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_messagedefinition-identifier.md): **[MessageDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/messagedefinition.html)** Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
- [Get history of MessageDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_messagedefinition-identifier-history.md): **[MessageDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/messagedefinition.html)** Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
- [Get MessageDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_messagedefinition-identifier-history-versionidentifier.md): **[MessageDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/messagedefinition.html)** Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
- [Search MessageHeaders](https://api-reference.oystehr.com/reference/get_messageheader.md): **[MessageHeader on the FHIR specification website.](https://www.hl7.org/fhir/r4b/messageheader.html)** The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
- [Create a new MessageHeader](https://api-reference.oystehr.com/reference/post_messageheader.md): **[MessageHeader on the FHIR specification website.](https://www.hl7.org/fhir/r4b/messageheader.html)** The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. The body should be a valid FHIR object for MessageHeader. Here is an example: ```json { "resourceType": "MessageHeader", "id": "1cbdfb97-5859-48a4-8301-d54eab818d68", "text": { "status": "generated", "div": "\n
Update Person resource for Peter James CHALMERS (Jim), MRN: 12345 (Acme Healthcare)
\n
\n
Update Person resource for Peter James CHALMERS (Jim), MRN: 12345 (Acme Healthcare)
\n
Generated Narrative with Details
id: breastcancer
type: rna
coordinateSystem: 0
patient: Patient/brcapat
ReferenceSeqs
| - | ReferenceSeqId | WindowStart | WindowEnd |
| * | Homo sapiens BRCA2, DNA repair associated (BRCA2), mRNA (Details : {http://www.ncbi.nlm.nih.gov/nuccore/ code 'NM_000059.3' = 'NM_000059.3', given as 'Homo sapiens BRCA2, DNA repair associated (BRCA2), mRNA'}) | 101488058 | 101499444 |
Variants
| - | Start | End | ObservedAllele | ReferenceAllele |
| * | 32316186 | 32316187 | A | C |
Generated Narrative with Details
id: breastcancer
type: rna
coordinateSystem: 0
patient: Patient/brcapat
ReferenceSeqs
| - | ReferenceSeqId | WindowStart | WindowEnd |
| * | Homo sapiens BRCA2, DNA repair associated (BRCA2), mRNA (Details : {http://www.ncbi.nlm.nih.gov/nuccore/ code 'NM_000059.3' = 'NM_000059.3', given as 'Homo sapiens BRCA2, DNA repair associated (BRCA2), mRNA'}) | 101488058 | 101499444 |
Variants
| - | Start | End | ObservedAllele | ReferenceAllele |
| * | 32316186 | 32316187 | A | C |
\n
\n Australian IHI Number\n
\n \n
oid: 1.2.36.1.2001.1003.0
\n \n
uri: http://ns.electronichealth.net.au/id/hi/ihi/1.0
\n \n
\n
\n Australian IHI Number\n
\n \n
oid: 1.2.36.1.2001.1003.0
\n \n
uri: http://ns.electronichealth.net.au/id/hi/ihi/1.0
\n \n
Generated Narrative with Details
id: 656
identifier: patientId-urn:oid:1.2.4~0000000000000000~152584~20170503155426~820
status: final
code: MDC_FLOW_AWAY_EXP_FORCED_PEAK (Details : {urn:iso:std:iso:11073:10101 code '152584' = '152584', given as 'MDC_FLOW_AWAY_EXP_FORCED_PEAK'})
subject: Patient/PatientId-patientId
effective: 03/05/2017 3:54:26 PM
performer: Patient/PatientId-patientId
value: 820 cL/s (Details: urn:iso:std:iso:11073:10101 code 265201 = '265201')
Generated Narrative with Details
id: 656
identifier: patientId-urn:oid:1.2.4~0000000000000000~152584~20170503155426~820
status: final
code: MDC_FLOW_AWAY_EXP_FORCED_PEAK (Details : {urn:iso:std:iso:11073:10101 code '152584' = '152584', given as 'MDC_FLOW_AWAY_EXP_FORCED_PEAK'})
subject: Patient/PatientId-patientId
effective: 03/05/2017 3:54:26 PM
performer: Patient/PatientId-patientId
value: 820 cL/s (Details: urn:iso:std:iso:11073:10101 code 265201 = '265201')
Generated Narrative with Details
id: example
code: Glucose [Moles/volume] in Blood (Details : {LOINC code '15074-8' = 'Glucose [Moles/volume] in Blood', given as 'Glucose [Moles/volume] in Blood'})
Generated Narrative with Details
id: example
code: Glucose [Moles/volume] in Blood (Details : {LOINC code '15074-8' = 'Glucose [Moles/volume] in Blood', given as 'Glucose [Moles/volume] in Blood'})
\n
The code "W" is not known and not legal Patient.gender.
\n
\n
The code "W" is not known and not legal Patient.gender.
\n
\n \n
Gastroenterology @ Acme Hospital. ph: +1 555 234 3523, email: \n gastro@acme.org\n
\n \n
\n \n
Gastroenterology @ Acme Hospital. ph: +1 555 234 3523, email: \n gastro@acme.org\n
\n \n
\n\t\t\t
\n\t\t\t\tHL7 Payer Network services for Acme Hospital from 1-Jan 2012 to 31-Mar 2012\n\t\t\t
\n\t\t
\n\t\t\t
\n\t\t\t\tHL7 Payer Network services for Acme Hospital from 1-Jan 2012 to 31-Mar 2012\n\t\t\t
\n\t\t
\n
\n \n \n | 名字 | \n 张无忌 |
\n \n | 地址 | \n 上海市黄埔区马当路190号, 1974年12月25日 | \n
\n \n | 联系方式 | \n 住宅: 不详。工作: 18337177888 | \n
\n \n | Id | \n MRN: 3112219680806371X (市卫生局) | \n
\n \n
\n
\n
\n \n \n | 名字 | \n 张无忌 |
\n \n | 地址 | \n 上海市黄埔区马当路190号, 1974年12月25日 | \n
\n \n | 联系方式 | \n 住宅: 不详。工作: 18337177888 | \n
\n \n | Id | \n MRN: 3112219680806371X (市卫生局) | \n
\n \n
\n
A human-readable rendering of the PaymentNotice
" }, "identifier": [ { "system": "http://benefitsinc.com/paymentnotice", "value": "776543" } ], "status": "active", "request": { "reference": "http://benefitsinc.com/fhir/claim/12345" }, "response": { "reference": "http://benefitsinc.com/fhir/claimresponse/CR12345" }, "created": "2014-08-16", "provider": { "reference": "Organization/1" }, "payment": { "reference": "PaymentReconciliation/ER2500" }, "paymentDate": "2014-08-15", "payee": { "reference": "Organization/1" }, "recipient": { "identifier": { "system": "http://regulators.gov", "value": "AB123" } }, "amount": { "value": 12500, "currency": "USD" }, "paymentStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/paymentstatus", "code": "paid" } ] } } ``` You can reference the FHIR documentation to determine the format for [`PaymentNotice`](https://www.hl7.org/fhir/r4b/PaymentNotice.html).
- [Search PaymentNotices](https://api-reference.oystehr.com/reference/post_paymentnotice-search.md): **[PaymentNotice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentnotice.html)** This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
- [Get PaymentNotice with identifier {identifier}](https://api-reference.oystehr.com/reference/get_paymentnotice-identifier.md): **[PaymentNotice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentnotice.html)** This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
- [Update PaymentNotice with identifier {identifier}](https://api-reference.oystehr.com/reference/put_paymentnotice-identifier.md): **[PaymentNotice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentnotice.html)** This resource provides the status of the payment for goods and services rendered, and the request and response resource references. The body should be a valid FHIR object for PaymentNotice. Here is an example: ```json { "resourceType": "PaymentNotice", "id": "77654", "text": { "status": "generated", "div": "A human-readable rendering of the PaymentNotice
" }, "identifier": [ { "system": "http://benefitsinc.com/paymentnotice", "value": "776543" } ], "status": "active", "request": { "reference": "http://benefitsinc.com/fhir/claim/12345" }, "response": { "reference": "http://benefitsinc.com/fhir/claimresponse/CR12345" }, "created": "2014-08-16", "provider": { "reference": "Organization/1" }, "payment": { "reference": "PaymentReconciliation/ER2500" }, "paymentDate": "2014-08-15", "payee": { "reference": "Organization/1" }, "recipient": { "identifier": { "system": "http://regulators.gov", "value": "AB123" } }, "amount": { "value": 12500, "currency": "USD" }, "paymentStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/paymentstatus", "code": "paid" } ] } } ``` You can reference the FHIR documentation to determine the format for [`PaymentNotice`](https://www.hl7.org/fhir/r4b/PaymentNotice.html).
- [Patch PaymentNotice with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_paymentnotice-identifier.md): **[PaymentNotice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentnotice.html)** This resource provides the status of the payment for goods and services rendered, and the request and response resource references. The body should be a list of valid JSON patches for PaymentNotice. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete PaymentNotice with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_paymentnotice-identifier.md): **[PaymentNotice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentnotice.html)** This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
- [Get history of PaymentNotice with identifier {identifier}](https://api-reference.oystehr.com/reference/get_paymentnotice-identifier-history.md): **[PaymentNotice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentnotice.html)** This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
- [Get PaymentNotice with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_paymentnotice-identifier-history-versionidentifier.md): **[PaymentNotice on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentnotice.html)** This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
- [Search PaymentReconciliations](https://api-reference.oystehr.com/reference/get_paymentreconciliation.md): **[PaymentReconciliation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentreconciliation.html)** This resource provides the details including amount of a payment and allocates the payment items being paid.
- [Create a new PaymentReconciliation](https://api-reference.oystehr.com/reference/post_paymentreconciliation.md): **[PaymentReconciliation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentreconciliation.html)** This resource provides the details including amount of a payment and allocates the payment items being paid. The body should be a valid FHIR object for PaymentReconciliation. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`PaymentReconciliation`](https://www.hl7.org/fhir/r4b/PaymentReconciliation.html).
- [Search PaymentReconciliations](https://api-reference.oystehr.com/reference/post_paymentreconciliation-search.md): **[PaymentReconciliation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentreconciliation.html)** This resource provides the details including amount of a payment and allocates the payment items being paid.
- [Get PaymentReconciliation with identifier {identifier}](https://api-reference.oystehr.com/reference/get_paymentreconciliation-identifier.md): **[PaymentReconciliation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentreconciliation.html)** This resource provides the details including amount of a payment and allocates the payment items being paid.
- [Update PaymentReconciliation with identifier {identifier}](https://api-reference.oystehr.com/reference/put_paymentreconciliation-identifier.md): **[PaymentReconciliation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentreconciliation.html)** This resource provides the details including amount of a payment and allocates the payment items being paid. The body should be a valid FHIR object for PaymentReconciliation. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`PaymentReconciliation`](https://www.hl7.org/fhir/r4b/PaymentReconciliation.html).
- [Patch PaymentReconciliation with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_paymentreconciliation-identifier.md): **[PaymentReconciliation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentreconciliation.html)** This resource provides the details including amount of a payment and allocates the payment items being paid. The body should be a list of valid JSON patches for PaymentReconciliation. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete PaymentReconciliation with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_paymentreconciliation-identifier.md): **[PaymentReconciliation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentreconciliation.html)** This resource provides the details including amount of a payment and allocates the payment items being paid.
- [Get history of PaymentReconciliation with identifier {identifier}](https://api-reference.oystehr.com/reference/get_paymentreconciliation-identifier-history.md): **[PaymentReconciliation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentreconciliation.html)** This resource provides the details including amount of a payment and allocates the payment items being paid.
- [Get PaymentReconciliation with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_paymentreconciliation-identifier-history-versionidentifier.md): **[PaymentReconciliation on the FHIR specification website.](https://www.hl7.org/fhir/r4b/paymentreconciliation.html)** This resource provides the details including amount of a payment and allocates the payment items being paid.
- [Search Persons](https://api-reference.oystehr.com/reference/get_person.md): **[Person on the FHIR specification website.](https://www.hl7.org/fhir/r4b/person.html)** Demographics and administrative information about a person independent of a specific health-related context.
- [Create a new Person](https://api-reference.oystehr.com/reference/post_person.md): **[Person on the FHIR specification website.](https://www.hl7.org/fhir/r4b/person.html)** Demographics and administrative information about a person independent of a specific health-related context. The body should be a valid FHIR object for Person. Here is an example: ```json { "resourceType": "Person", "id": "example", "text": { "status": "generated", "div": "\n
\n \n \n | Name | \n Peter James Chalmers ("Jim") | \n
\n \n | Address | \n 534 Erewhon, Pleasantville, Vic, 3999 | \n
\n \n | Contacts | \n Home: unknown. Work: (03) 5555 6473 | \n
\n \n | Id | \n MRN: 12345 (Acme Healthcare) | \n
\n \n
\n
\n
\n \n \n | Name | \n Peter James Chalmers ("Jim") | \n
\n \n | Address | \n 534 Erewhon, Pleasantville, Vic, 3999 | \n
\n \n | Contacts | \n Home: unknown. Work: (03) 5555 6473 | \n
\n \n | Id | \n MRN: 12345 (Acme Healthcare) | \n
\n \n
\n
[Put rendering here]
" }, "contained": [ { "resourceType": "ActivityDefinition", "id": "activitydefinition-medicationrequest-1", "status": "draft", "kind": "MedicationRequest", "productCodeableConcept": { "text": "Medication 1" } }, { "resourceType": "ActivityDefinition", "id": "activitydefinition-medicationrequest-2", "status": "draft", "kind": "MedicationRequest", "productCodeableConcept": { "text": "Medication 2" } } ], "title": "This example illustrates relationships between actions.", "status": "draft", "action": [ { "groupingBehavior": "logical-group", "selectionBehavior": "all", "action": [ { "id": "medication-action-1", "title": "Administer Medication 1", "definitionCanonical": "#activitydefinition-medicationrequest-1" }, { "id": "medication-action-2", "title": "Administer Medication 2", "relatedAction": [ { "actionId": "medication-action-1", "relationship": "after-end", "offsetDuration": { "value": 1, "unit": "h" } } ], "definitionCanonical": "#activitydefinition-medicationrequest-2" } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`PlanDefinition`](https://www.hl7.org/fhir/r4b/PlanDefinition.html).
- [Search PlanDefinitions](https://api-reference.oystehr.com/reference/post_plandefinition-search.md): **[PlanDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/plandefinition.html)** This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
- [Get PlanDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_plandefinition-identifier.md): **[PlanDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/plandefinition.html)** This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
- [Update PlanDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_plandefinition-identifier.md): **[PlanDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/plandefinition.html)** This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications. The body should be a valid FHIR object for PlanDefinition. Here is an example: ```json { "resourceType": "PlanDefinition", "id": "options-example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "contained": [ { "resourceType": "ActivityDefinition", "id": "activitydefinition-medicationrequest-1", "status": "draft", "kind": "MedicationRequest", "productCodeableConcept": { "text": "Medication 1" } }, { "resourceType": "ActivityDefinition", "id": "activitydefinition-medicationrequest-2", "status": "draft", "kind": "MedicationRequest", "productCodeableConcept": { "text": "Medication 2" } } ], "title": "This example illustrates relationships between actions.", "status": "draft", "action": [ { "groupingBehavior": "logical-group", "selectionBehavior": "all", "action": [ { "id": "medication-action-1", "title": "Administer Medication 1", "definitionCanonical": "#activitydefinition-medicationrequest-1" }, { "id": "medication-action-2", "title": "Administer Medication 2", "relatedAction": [ { "actionId": "medication-action-1", "relationship": "after-end", "offsetDuration": { "value": 1, "unit": "h" } } ], "definitionCanonical": "#activitydefinition-medicationrequest-2" } ] } ] } ``` You can reference the FHIR documentation to determine the format for [`PlanDefinition`](https://www.hl7.org/fhir/r4b/PlanDefinition.html).
- [Patch PlanDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_plandefinition-identifier.md): **[PlanDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/plandefinition.html)** This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications. The body should be a list of valid JSON patches for PlanDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete PlanDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_plandefinition-identifier.md): **[PlanDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/plandefinition.html)** This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
- [Get history of PlanDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_plandefinition-identifier-history.md): **[PlanDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/plandefinition.html)** This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
- [Get PlanDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_plandefinition-identifier-history-versionidentifier.md): **[PlanDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/plandefinition.html)** This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
- [Search Practitioners](https://api-reference.oystehr.com/reference/get_practitioner.md): **[Practitioner on the FHIR specification website.](https://www.hl7.org/fhir/r4b/practitioner.html)** A person who is directly or indirectly involved in the provisioning of healthcare.
- [Create a new Practitioner](https://api-reference.oystehr.com/reference/post_practitioner.md): **[Practitioner on the FHIR specification website.](https://www.hl7.org/fhir/r4b/practitioner.html)** A person who is directly or indirectly involved in the provisioning of healthcare. The body should be a valid FHIR object for Practitioner. Here is an example: ```json { "resourceType": "Practitioner", "id": "example", "text": { "status": "generated", "div": "\n
Dr Adam Careful is a Referring Practitioner for Acme Hospital from 1-Jan 2012 to 31-Mar\n 2012
\n
\n
Dr Adam Careful is a Referring Practitioner for Acme Hospital from 1-Jan 2012 to 31-Mar\n 2012
\n
\n\t\t\t
\n\t\t\t\tDr Adam Careful is a Referring Practitioner for Acme Hospital from 1-Jan 2012 to 31-Mar\n\t\t\t\t2012\n\t\t\t
\n\t\t
\n\t\t\t
\n\t\t\t\tDr Adam Careful is a Referring Practitioner for Acme Hospital from 1-Jan 2012 to 31-Mar\n\t\t\t\t2012\n\t\t\t
\n\t\t
\n\t\t\t
\n\t\t\t\t Personal care services provided at person's home\n\t\t\t
\n\t\t\t
\n\t\t\t\t Based On : Peter's Long Term Services and Supports (LTSS) care plan
\n\t\t\t
\n\t\t\t\t Status : completed
\n\t\t\t
\n\t\t\t\t Beneficiary : Peter James
\n\t\t\t
\n\t\t\t\t Service Name/Code : Personal care services (Details : {HCPCS code 'T1019' = 'Personal care services, per 15 minutes'})\n\t\t\t
\n\t\t\t
\n\t\t\t\t Service Date : Apr 5, 2018
\n\t\t\t
\n\t\t\t\t Service Provider : Adam Careful
\n\t\t\t
\n\t\t\t\t Service Delivery Address : Peter's home
\n\t\t\t
\n\t\t\t\t Service Comment : Assisted with bathing and dressing, doing laundry, and meal preparation
\n\t\t
\n\t\t\t
\n\t\t\t\t Personal care services provided at person's home\n\t\t\t
\n\t\t\t
\n\t\t\t\t Based On : Peter's Long Term Services and Supports (LTSS) care plan
\n\t\t\t
\n\t\t\t\t Status : completed
\n\t\t\t
\n\t\t\t\t Beneficiary : Peter James
\n\t\t\t
\n\t\t\t\t Service Name/Code : Personal care services (Details : {HCPCS code 'T1019' = 'Personal care services, per 15 minutes'})\n\t\t\t
\n\t\t\t
\n\t\t\t\t Service Date : Apr 5, 2018
\n\t\t\t
\n\t\t\t\t Service Provider : Adam Careful
\n\t\t\t
\n\t\t\t\t Service Delivery Address : Peter's home
\n\t\t\t
\n\t\t\t\t Service Comment : Assisted with bathing and dressing, doing laundry, and meal preparation
\n\t\t
Generated Narrative with Details
id: consent-signature
target: Consent/consent-example-signature
recorded: 26/05/2016 12:41:10 AM
Agents
| - | Role | Who |
| * | author (originator) (Details : {http://terminology.hl7.org/CodeSystem/v3-ParticipationType code 'AUT' = 'author (originator)) | Patient/72 |
signature:
Generated Narrative with Details
id: consent-signature
target: Consent/consent-example-signature
recorded: 26/05/2016 12:41:10 AM
Agents
| - | Role | Who |
| * | author (originator) (Details : {http://terminology.hl7.org/CodeSystem/v3-ParticipationType code 'AUT' = 'author (originator)) | Patient/72 |
signature:
\n
Lifelines Questionnaire 1 part 1\n 1. Do you have allergies?\n 2. General Questions:\n 2.a) What is your gender?\n 2.b) What is your date of birth?\n 2.c) What is your country of birth?\n 2.d) What is your marital status?\n 3. Intoxications:\n 3.a) Do you smoke?\n 3.b) Do you drink alcohol?
\n
\n
Lifelines Questionnaire 1 part 1\n 1. Do you have allergies?\n 2. General Questions:\n 2.a) What is your gender?\n 2.b) What is your date of birth?\n 2.c) What is your country of birth?\n 2.d) What is your marital status?\n 3. Intoxications:\n 3.a) Do you smoke?\n 3.b) Do you drink alcohol?
\n
\n
\n \n \n | Name | \n Bénédicte du Marché | \n
\n \n | Address | \n 43, Place du Marché Sainte Catherine, 75004 Paris, France | \n
\n \n | Contacts | \n Phone: +33 (237) 998327 | \n
\n \n
\n
\n
\n \n \n | Name | \n Bénédicte du Marché | \n
\n \n | Address | \n 43, Place du Marché Sainte Catherine, 75004 Paris, France | \n
\n \n | Contacts | \n Phone: +33 (237) 998327 | \n
\n \n
\n
[Put rendering here]
" }, "status": "draft", "population": { "reference": "ResearchElementDefinition/example" } } ``` You can reference the FHIR documentation to determine the format for [`ResearchDefinition`](https://www.hl7.org/fhir/r4b/ResearchDefinition.html).
- [Search ResearchDefinitions](https://api-reference.oystehr.com/reference/post_researchdefinition-search.md): **[ResearchDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchdefinition.html)** The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.
- [Get ResearchDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_researchdefinition-identifier.md): **[ResearchDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchdefinition.html)** The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.
- [Update ResearchDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_researchdefinition-identifier.md): **[ResearchDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchdefinition.html)** The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about. The body should be a valid FHIR object for ResearchDefinition. Here is an example: ```json { "resourceType": "ResearchDefinition", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "draft", "population": { "reference": "ResearchElementDefinition/example" } } ``` You can reference the FHIR documentation to determine the format for [`ResearchDefinition`](https://www.hl7.org/fhir/r4b/ResearchDefinition.html).
- [Patch ResearchDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_researchdefinition-identifier.md): **[ResearchDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchdefinition.html)** The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about. The body should be a list of valid JSON patches for ResearchDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ResearchDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_researchdefinition-identifier.md): **[ResearchDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchdefinition.html)** The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.
- [Get history of ResearchDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_researchdefinition-identifier-history.md): **[ResearchDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchdefinition.html)** The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.
- [Get ResearchDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_researchdefinition-identifier-history-versionidentifier.md): **[ResearchDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchdefinition.html)** The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.
- [Search ResearchElementDefinitions](https://api-reference.oystehr.com/reference/get_researchelementdefinition.md): **[ResearchElementDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchelementdefinition.html)** The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
- [Create a new ResearchElementDefinition](https://api-reference.oystehr.com/reference/post_researchelementdefinition.md): **[ResearchElementDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchelementdefinition.html)** The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about. The body should be a valid FHIR object for ResearchElementDefinition. Here is an example: ```json { "resourceType": "ResearchElementDefinition", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "draft", "type": "population", "characteristic": [ { "definitionCodeableConcept": { "text": "Diabetic patients over 65" } } ] } ``` You can reference the FHIR documentation to determine the format for [`ResearchElementDefinition`](https://www.hl7.org/fhir/r4b/ResearchElementDefinition.html).
- [Search ResearchElementDefinitions](https://api-reference.oystehr.com/reference/post_researchelementdefinition-search.md): **[ResearchElementDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchelementdefinition.html)** The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
- [Get ResearchElementDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_researchelementdefinition-identifier.md): **[ResearchElementDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchelementdefinition.html)** The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
- [Update ResearchElementDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/put_researchelementdefinition-identifier.md): **[ResearchElementDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchelementdefinition.html)** The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about. The body should be a valid FHIR object for ResearchElementDefinition. Here is an example: ```json { "resourceType": "ResearchElementDefinition", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "draft", "type": "population", "characteristic": [ { "definitionCodeableConcept": { "text": "Diabetic patients over 65" } } ] } ``` You can reference the FHIR documentation to determine the format for [`ResearchElementDefinition`](https://www.hl7.org/fhir/r4b/ResearchElementDefinition.html).
- [Patch ResearchElementDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_researchelementdefinition-identifier.md): **[ResearchElementDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchelementdefinition.html)** The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about. The body should be a list of valid JSON patches for ResearchElementDefinition. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ResearchElementDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_researchelementdefinition-identifier.md): **[ResearchElementDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchelementdefinition.html)** The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
- [Get history of ResearchElementDefinition with identifier {identifier}](https://api-reference.oystehr.com/reference/get_researchelementdefinition-identifier-history.md): **[ResearchElementDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchelementdefinition.html)** The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
- [Get ResearchElementDefinition with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_researchelementdefinition-identifier-history-versionidentifier.md): **[ResearchElementDefinition on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchelementdefinition.html)** The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
- [Search ResearchStudys](https://api-reference.oystehr.com/reference/get_researchstudy.md): **[ResearchStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchstudy.html)** A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
- [Create a new ResearchStudy](https://api-reference.oystehr.com/reference/post_researchstudy.md): **[ResearchStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchstudy.html)** A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects. The body should be a valid FHIR object for ResearchStudy. Here is an example: ```json { "resourceType": "ResearchStudy", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "completed" } ``` You can reference the FHIR documentation to determine the format for [`ResearchStudy`](https://www.hl7.org/fhir/r4b/ResearchStudy.html).
- [Search ResearchStudys](https://api-reference.oystehr.com/reference/post_researchstudy-search.md): **[ResearchStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchstudy.html)** A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
- [Get ResearchStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/get_researchstudy-identifier.md): **[ResearchStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchstudy.html)** A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
- [Update ResearchStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/put_researchstudy-identifier.md): **[ResearchStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchstudy.html)** A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects. The body should be a valid FHIR object for ResearchStudy. Here is an example: ```json { "resourceType": "ResearchStudy", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "completed" } ``` You can reference the FHIR documentation to determine the format for [`ResearchStudy`](https://www.hl7.org/fhir/r4b/ResearchStudy.html).
- [Patch ResearchStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_researchstudy-identifier.md): **[ResearchStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchstudy.html)** A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects. The body should be a list of valid JSON patches for ResearchStudy. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ResearchStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_researchstudy-identifier.md): **[ResearchStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchstudy.html)** A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
- [Get history of ResearchStudy with identifier {identifier}](https://api-reference.oystehr.com/reference/get_researchstudy-identifier-history.md): **[ResearchStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchstudy.html)** A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
- [Get ResearchStudy with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_researchstudy-identifier-history-versionidentifier.md): **[ResearchStudy on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchstudy.html)** A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
- [Search ResearchSubjects](https://api-reference.oystehr.com/reference/get_researchsubject.md): **[ResearchSubject on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchsubject.html)** A physical entity which is the primary unit of operational and/or administrative interest in a study.
- [Create a new ResearchSubject](https://api-reference.oystehr.com/reference/post_researchsubject.md): **[ResearchSubject on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchsubject.html)** A physical entity which is the primary unit of operational and/or administrative interest in a study. The body should be a valid FHIR object for ResearchSubject. Here is an example: ```json { "resourceType": "ResearchSubject", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "identifier": [ { "type": { "text": "Subject id" }, "system": "http://example.org/studysubjectids", "value": "123" } ], "status": "candidate", "study": { "reference": "ResearchStudy/example" }, "individual": { "reference": "Patient/example" } } ``` You can reference the FHIR documentation to determine the format for [`ResearchSubject`](https://www.hl7.org/fhir/r4b/ResearchSubject.html).
- [Search ResearchSubjects](https://api-reference.oystehr.com/reference/post_researchsubject-search.md): **[ResearchSubject on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchsubject.html)** A physical entity which is the primary unit of operational and/or administrative interest in a study.
- [Get ResearchSubject with identifier {identifier}](https://api-reference.oystehr.com/reference/get_researchsubject-identifier.md): **[ResearchSubject on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchsubject.html)** A physical entity which is the primary unit of operational and/or administrative interest in a study.
- [Update ResearchSubject with identifier {identifier}](https://api-reference.oystehr.com/reference/put_researchsubject-identifier.md): **[ResearchSubject on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchsubject.html)** A physical entity which is the primary unit of operational and/or administrative interest in a study. The body should be a valid FHIR object for ResearchSubject. Here is an example: ```json { "resourceType": "ResearchSubject", "id": "example", "text": { "status": "generated", "div": "[Put rendering here]
" }, "identifier": [ { "type": { "text": "Subject id" }, "system": "http://example.org/studysubjectids", "value": "123" } ], "status": "candidate", "study": { "reference": "ResearchStudy/example" }, "individual": { "reference": "Patient/example" } } ``` You can reference the FHIR documentation to determine the format for [`ResearchSubject`](https://www.hl7.org/fhir/r4b/ResearchSubject.html).
- [Patch ResearchSubject with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_researchsubject-identifier.md): **[ResearchSubject on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchsubject.html)** A physical entity which is the primary unit of operational and/or administrative interest in a study. The body should be a list of valid JSON patches for ResearchSubject. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete ResearchSubject with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_researchsubject-identifier.md): **[ResearchSubject on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchsubject.html)** A physical entity which is the primary unit of operational and/or administrative interest in a study.
- [Get history of ResearchSubject with identifier {identifier}](https://api-reference.oystehr.com/reference/get_researchsubject-identifier-history.md): **[ResearchSubject on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchsubject.html)** A physical entity which is the primary unit of operational and/or administrative interest in a study.
- [Get ResearchSubject with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_researchsubject-identifier-history-versionidentifier.md): **[ResearchSubject on the FHIR specification website.](https://www.hl7.org/fhir/r4b/researchsubject.html)** A physical entity which is the primary unit of operational and/or administrative interest in a study.
- [Search RiskAssessments](https://api-reference.oystehr.com/reference/get_riskassessment.md): **[RiskAssessment on the FHIR specification website.](https://www.hl7.org/fhir/r4b/riskassessment.html)** An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
- [Create a new RiskAssessment](https://api-reference.oystehr.com/reference/post_riskassessment.md): **[RiskAssessment on the FHIR specification website.](https://www.hl7.org/fhir/r4b/riskassessment.html)** An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome. The body should be a valid FHIR object for RiskAssessment. Here is an example: ```json { "resourceType": "RiskAssessment", "id": "breastcancer-risk", "text": { "status": "additional", "div": "\n
\n \n \n Information about your risk score:\n | \n
\n \n | \n Birthdate:\n | \n 1981-01-01 | \n
\n \n | \n Gender:\n | \n female | \n
\n \n | \n Ethnicity:\n | \n Unknown / Not Reported | \n
\n
\n
\n
\n \n \n Information about your risk score:\n | \n
\n \n | \n Birthdate:\n | \n 1981-01-01 | \n
\n \n | \n Gender:\n | \n female | \n
\n \n | \n Ethnicity:\n | \n Unknown / Not Reported | \n
\n
\n
\n Burgers UMC, South Wing, second floor Physiotherapy Schedule\n
" }, "identifier": [ { "use": "usual", "system": "http://example.org/scheduleid", "value": "45" } ], "active": true, "serviceCategory": [ { "coding": [ { "code": "17", "display": "General Practice" } ] } ], "serviceType": [ { "coding": [ { "code": "57", "display": "Immunization" } ] } ], "specialty": [ { "coding": [ { "code": "408480009", "display": "Clinical immunology" } ] } ], "actor": [ { "reference": "Location/1", "display": "Burgers UMC, South Wing, second floor" } ], "planningHorizon": { "start": "2013-12-25T09:15:00Z", "end": "2013-12-25T09:30:00Z" }, "comment": "The slots attached to this schedule should be specialized to cover immunizations within the clinic" } ``` You can reference the FHIR documentation to determine the format for [`Schedule`](https://www.hl7.org/fhir/r4b/Schedule.html).
- [Search Schedules](https://api-reference.oystehr.com/reference/post_schedule-search.md): **[Schedule on the FHIR specification website.](https://www.hl7.org/fhir/r4b/schedule.html)** A container for slots of time that may be available for booking appointments.
- [Get Schedule with identifier {identifier}](https://api-reference.oystehr.com/reference/get_schedule-identifier.md): **[Schedule on the FHIR specification website.](https://www.hl7.org/fhir/r4b/schedule.html)** A container for slots of time that may be available for booking appointments.
- [Update Schedule with identifier {identifier}](https://api-reference.oystehr.com/reference/put_schedule-identifier.md): **[Schedule on the FHIR specification website.](https://www.hl7.org/fhir/r4b/schedule.html)** A container for slots of time that may be available for booking appointments. The body should be a valid FHIR object for Schedule. Here is an example: ```json { "resourceType": "Schedule", "id": "example", "text": { "status": "generated", "div": "\n Burgers UMC, South Wing, second floor Physiotherapy Schedule\n
" }, "identifier": [ { "use": "usual", "system": "http://example.org/scheduleid", "value": "45" } ], "active": true, "serviceCategory": [ { "coding": [ { "code": "17", "display": "General Practice" } ] } ], "serviceType": [ { "coding": [ { "code": "57", "display": "Immunization" } ] } ], "specialty": [ { "coding": [ { "code": "408480009", "display": "Clinical immunology" } ] } ], "actor": [ { "reference": "Location/1", "display": "Burgers UMC, South Wing, second floor" } ], "planningHorizon": { "start": "2013-12-25T09:15:00Z", "end": "2013-12-25T09:30:00Z" }, "comment": "The slots attached to this schedule should be specialized to cover immunizations within the clinic" } ``` You can reference the FHIR documentation to determine the format for [`Schedule`](https://www.hl7.org/fhir/r4b/Schedule.html).
- [Patch Schedule with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_schedule-identifier.md): **[Schedule on the FHIR specification website.](https://www.hl7.org/fhir/r4b/schedule.html)** A container for slots of time that may be available for booking appointments. The body should be a list of valid JSON patches for Schedule. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Schedule with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_schedule-identifier.md): **[Schedule on the FHIR specification website.](https://www.hl7.org/fhir/r4b/schedule.html)** A container for slots of time that may be available for booking appointments.
- [Get history of Schedule with identifier {identifier}](https://api-reference.oystehr.com/reference/get_schedule-identifier-history.md): **[Schedule on the FHIR specification website.](https://www.hl7.org/fhir/r4b/schedule.html)** A container for slots of time that may be available for booking appointments.
- [Get Schedule with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_schedule-identifier-history-versionidentifier.md): **[Schedule on the FHIR specification website.](https://www.hl7.org/fhir/r4b/schedule.html)** A container for slots of time that may be available for booking appointments.
- [Search SearchParameters](https://api-reference.oystehr.com/reference/get_searchparameter.md): **[SearchParameter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/searchparameter.html)** A search parameter that defines a named search item that can be used to search/filter on a resource.
- [Create a new SearchParameter](https://api-reference.oystehr.com/reference/post_searchparameter.md): **[SearchParameter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/searchparameter.html)** A search parameter that defines a named search item that can be used to search/filter on a resource. The body should be a valid FHIR object for SearchParameter. Here is an example: ```json { "resourceType": "SearchParameter", "id": "Account-identifier", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "url": "http://hl7.org/fhir/SearchParameter/Account-identifier", "version": "4.0.1", "name": "identifier", "status": "draft", "experimental": false, "date": "2019-11-01T09:29:23+11:00", "publisher": "Health Level Seven International (Patient Administration)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/pafm/index.cfm" } ] } ], "description": "Account number", "code": "identifier", "base": [ "Account" ], "type": "token", "expression": "Account.identifier", "xpath": "f:Account/f:identifier", "xpathUsage": "normal" } ``` You can reference the FHIR documentation to determine the format for [`SearchParameter`](https://www.hl7.org/fhir/r4b/SearchParameter.html).
- [Search SearchParameters](https://api-reference.oystehr.com/reference/post_searchparameter-search.md): **[SearchParameter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/searchparameter.html)** A search parameter that defines a named search item that can be used to search/filter on a resource.
- [Get SearchParameter with identifier {identifier}](https://api-reference.oystehr.com/reference/get_searchparameter-identifier.md): **[SearchParameter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/searchparameter.html)** A search parameter that defines a named search item that can be used to search/filter on a resource.
- [Update SearchParameter with identifier {identifier}](https://api-reference.oystehr.com/reference/put_searchparameter-identifier.md): **[SearchParameter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/searchparameter.html)** A search parameter that defines a named search item that can be used to search/filter on a resource. The body should be a valid FHIR object for SearchParameter. Here is an example: ```json { "resourceType": "SearchParameter", "id": "Account-identifier", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "url": "http://hl7.org/fhir/SearchParameter/Account-identifier", "version": "4.0.1", "name": "identifier", "status": "draft", "experimental": false, "date": "2019-11-01T09:29:23+11:00", "publisher": "Health Level Seven International (Patient Administration)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/pafm/index.cfm" } ] } ], "description": "Account number", "code": "identifier", "base": [ "Account" ], "type": "token", "expression": "Account.identifier", "xpath": "f:Account/f:identifier", "xpathUsage": "normal" } ``` You can reference the FHIR documentation to determine the format for [`SearchParameter`](https://www.hl7.org/fhir/r4b/SearchParameter.html).
- [Patch SearchParameter with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_searchparameter-identifier.md): **[SearchParameter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/searchparameter.html)** A search parameter that defines a named search item that can be used to search/filter on a resource. The body should be a list of valid JSON patches for SearchParameter. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete SearchParameter with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_searchparameter-identifier.md): **[SearchParameter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/searchparameter.html)** A search parameter that defines a named search item that can be used to search/filter on a resource.
- [Get history of SearchParameter with identifier {identifier}](https://api-reference.oystehr.com/reference/get_searchparameter-identifier-history.md): **[SearchParameter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/searchparameter.html)** A search parameter that defines a named search item that can be used to search/filter on a resource.
- [Get SearchParameter with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_searchparameter-identifier-history-versionidentifier.md): **[SearchParameter on the FHIR specification website.](https://www.hl7.org/fhir/r4b/searchparameter.html)** A search parameter that defines a named search item that can be used to search/filter on a resource.
- [Search ServiceRequests](https://api-reference.oystehr.com/reference/get_servicerequest.md): **[ServiceRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/servicerequest.html)** A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
- [Create a new ServiceRequest](https://api-reference.oystehr.com/reference/post_servicerequest.md): **[ServiceRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/servicerequest.html)** A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. The body should be a valid FHIR object for ServiceRequest. Here is an example: ```json { "resourceType": "ServiceRequest", "id": "ambulation", "text": { "status": "generated", "div": "Generated Narrative with Details
id: ambulation
identifier: 45678
basedOn: Maternity care plan
status: completed
intent: order
code: Ambulation (Details : {SNOMED CT code '62013009' = 'Ambulating patient', given as 'Ambulating patient (procedure)'})
subject: Patient/example
authoredOn: 05/03/2017
requester: Dr. Beverly Crusher
reasonReference: Blood Pressure
Generated Narrative with Details
id: ambulation
identifier: 45678
basedOn: Maternity care plan
status: completed
intent: order
code: Ambulation (Details : {SNOMED CT code '62013009' = 'Ambulating patient', given as 'Ambulating patient (procedure)'})
subject: Patient/example
authoredOn: 05/03/2017
requester: Dr. Beverly Crusher
reasonReference: Blood Pressure
\n\t\t\t25 Dec 2013 9:00am - 9:15am: Busy Physiotherapy\n\t\t
" }, "identifier": [ { "system": "http://example.org/identifiers/slots", "value": "123132" } ], "serviceCategory": [ { "coding": [ { "code": "17", "display": "General Practice" } ] } ], "schedule": { "reference": "Schedule/example" }, "status": "busy", "start": "2013-12-25T09:00:00Z", "end": "2013-12-25T09:15:00Z", "overbooked": true, "comment": "Assessments should be performed before requesting appointments in this slot." } ``` You can reference the FHIR documentation to determine the format for [`Slot`](https://www.hl7.org/fhir/r4b/Slot.html).
- [Search Slots](https://api-reference.oystehr.com/reference/post_slot-search.md): **[Slot on the FHIR specification website.](https://www.hl7.org/fhir/r4b/slot.html)** A slot of time on a schedule that may be available for booking appointments.
- [Get Slot with identifier {identifier}](https://api-reference.oystehr.com/reference/get_slot-identifier.md): **[Slot on the FHIR specification website.](https://www.hl7.org/fhir/r4b/slot.html)** A slot of time on a schedule that may be available for booking appointments.
- [Update Slot with identifier {identifier}](https://api-reference.oystehr.com/reference/put_slot-identifier.md): **[Slot on the FHIR specification website.](https://www.hl7.org/fhir/r4b/slot.html)** A slot of time on a schedule that may be available for booking appointments. The body should be a valid FHIR object for Slot. Here is an example: ```json { "resourceType": "Slot", "id": "1", "text": { "status": "generated", "div": "\n\t\t\t25 Dec 2013 9:00am - 9:15am: Busy Physiotherapy\n\t\t
" }, "identifier": [ { "system": "http://example.org/identifiers/slots", "value": "123132" } ], "serviceCategory": [ { "coding": [ { "code": "17", "display": "General Practice" } ] } ], "schedule": { "reference": "Schedule/example" }, "status": "busy", "start": "2013-12-25T09:00:00Z", "end": "2013-12-25T09:15:00Z", "overbooked": true, "comment": "Assessments should be performed before requesting appointments in this slot." } ``` You can reference the FHIR documentation to determine the format for [`Slot`](https://www.hl7.org/fhir/r4b/Slot.html).
- [Patch Slot with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_slot-identifier.md): **[Slot on the FHIR specification website.](https://www.hl7.org/fhir/r4b/slot.html)** A slot of time on a schedule that may be available for booking appointments. The body should be a list of valid JSON patches for Slot. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Slot with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_slot-identifier.md): **[Slot on the FHIR specification website.](https://www.hl7.org/fhir/r4b/slot.html)** A slot of time on a schedule that may be available for booking appointments.
- [Get history of Slot with identifier {identifier}](https://api-reference.oystehr.com/reference/get_slot-identifier-history.md): **[Slot on the FHIR specification website.](https://www.hl7.org/fhir/r4b/slot.html)** A slot of time on a schedule that may be available for booking appointments.
- [Get Slot with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_slot-identifier-history-versionidentifier.md): **[Slot on the FHIR specification website.](https://www.hl7.org/fhir/r4b/slot.html)** A slot of time on a schedule that may be available for booking appointments.
- [Search Specimens](https://api-reference.oystehr.com/reference/get_specimen.md): **[Specimen on the FHIR specification website.](https://www.hl7.org/fhir/r4b/specimen.html)** A sample to be used for analysis.
- [Create a new Specimen](https://api-reference.oystehr.com/reference/post_specimen.md): **[Specimen on the FHIR specification website.](https://www.hl7.org/fhir/r4b/specimen.html)** A sample to be used for analysis. The body should be a valid FHIR object for Specimen. Here is an example: ```json { "resourceType": "Specimen", "id": "pooled-serum", "text": { "status": "generated", "div": "Generated Narrative with Details
id: pooled-serum
accessionIdentifier: 20171120-1234
type: Pooled serum sample (Details : {https://vetmed.iastate.edu/vdl code 'Serum sample, pooled' = 'Serum sample, pooled', given as 'Serum sample, pooled'})
subject: Group/herd1
Collections
| - | Collector | Collected[x] |
| * | James Herriot, FRCVS | 14/11/2017 |
Containers
| - | Type |
| * | Red Top Blood Collection Tube (Details : {https://vetmed.iastate.edu/vdl code 'RTT' = 'RTT', given as 'Red Top Tube'}) |
note: Pooled serum sample from 30 individuals
Generated Narrative with Details
id: pooled-serum
accessionIdentifier: 20171120-1234
type: Pooled serum sample (Details : {https://vetmed.iastate.edu/vdl code 'Serum sample, pooled' = 'Serum sample, pooled', given as 'Serum sample, pooled'})
subject: Group/herd1
Collections
| - | Collector | Collected[x] |
| * | James Herriot, FRCVS | 14/11/2017 |
Containers
| - | Type |
| * | Red Top Blood Collection Tube (Details : {https://vetmed.iastate.edu/vdl code 'RTT' = 'RTT', given as 'Red Top Tube'}) |
note: Pooled serum sample from 30 individuals
[Put rendering here]
" }, "status": "error", "contact": [ { "system": "phone", "value": "ext 4123" } ], "end": "2021-01-01T00:00:00Z", "reason": "Monitor new neonatal function", "criteria": "Observation?code=http://loinc.org|1975-2", "error": "Socket Error 10060 - can't connect to host", "channel": { "type": "rest-hook", "endpoint": "https://biliwatch.com/customers/mount-auburn-miu/on-result", "payload": "application/fhir+json", "header": [ "Authorization: Bearer secret-token-abc-123" ] } } ``` You can reference the FHIR documentation to determine the format for [`Subscription`](https://www.hl7.org/fhir/r4b/Subscription.html).
- [Search Subscriptions](https://api-reference.oystehr.com/reference/post_subscription-search.md): **[Subscription on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscription.html)** The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
- [Get Subscription with identifier {identifier}](https://api-reference.oystehr.com/reference/get_subscription-identifier.md): **[Subscription on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscription.html)** The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
- [Update Subscription with identifier {identifier}](https://api-reference.oystehr.com/reference/put_subscription-identifier.md): **[Subscription on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscription.html)** The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action. The body should be a valid FHIR object for Subscription. Here is an example: ```json { "resourceType": "Subscription", "id": "example-error", "text": { "status": "generated", "div": "[Put rendering here]
" }, "status": "error", "contact": [ { "system": "phone", "value": "ext 4123" } ], "end": "2021-01-01T00:00:00Z", "reason": "Monitor new neonatal function", "criteria": "Observation?code=http://loinc.org|1975-2", "error": "Socket Error 10060 - can't connect to host", "channel": { "type": "rest-hook", "endpoint": "https://biliwatch.com/customers/mount-auburn-miu/on-result", "payload": "application/fhir+json", "header": [ "Authorization: Bearer secret-token-abc-123" ] } } ``` You can reference the FHIR documentation to determine the format for [`Subscription`](https://www.hl7.org/fhir/r4b/Subscription.html).
- [Patch Subscription with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_subscription-identifier.md): **[Subscription on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscription.html)** The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action. The body should be a list of valid JSON patches for Subscription. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete Subscription with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_subscription-identifier.md): **[Subscription on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscription.html)** The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
- [Get history of Subscription with identifier {identifier}](https://api-reference.oystehr.com/reference/get_subscription-identifier-history.md): **[Subscription on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscription.html)** The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
- [Get Subscription with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_subscription-identifier-history-versionidentifier.md): **[Subscription on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscription.html)** The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
- [Search SubscriptionStatuss](https://api-reference.oystehr.com/reference/get_subscriptionstatus.md): **[SubscriptionStatus on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptionstatus.html)** The SubscriptionStatus resource describes the state of a Subscription during notifications.
- [Create a new SubscriptionStatus](https://api-reference.oystehr.com/reference/post_subscriptionstatus.md): **[SubscriptionStatus on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptionstatus.html)** The SubscriptionStatus resource describes the state of a Subscription during notifications. The body should be a valid FHIR object for SubscriptionStatus. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`SubscriptionStatus`](https://www.hl7.org/fhir/r4b/SubscriptionStatus.html).
- [Search SubscriptionStatuss](https://api-reference.oystehr.com/reference/post_subscriptionstatus-search.md): **[SubscriptionStatus on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptionstatus.html)** The SubscriptionStatus resource describes the state of a Subscription during notifications.
- [Get SubscriptionStatus with identifier {identifier}](https://api-reference.oystehr.com/reference/get_subscriptionstatus-identifier.md): **[SubscriptionStatus on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptionstatus.html)** The SubscriptionStatus resource describes the state of a Subscription during notifications.
- [Update SubscriptionStatus with identifier {identifier}](https://api-reference.oystehr.com/reference/put_subscriptionstatus-identifier.md): **[SubscriptionStatus on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptionstatus.html)** The SubscriptionStatus resource describes the state of a Subscription during notifications. The body should be a valid FHIR object for SubscriptionStatus. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`SubscriptionStatus`](https://www.hl7.org/fhir/r4b/SubscriptionStatus.html).
- [Patch SubscriptionStatus with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_subscriptionstatus-identifier.md): **[SubscriptionStatus on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptionstatus.html)** The SubscriptionStatus resource describes the state of a Subscription during notifications. The body should be a list of valid JSON patches for SubscriptionStatus. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete SubscriptionStatus with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_subscriptionstatus-identifier.md): **[SubscriptionStatus on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptionstatus.html)** The SubscriptionStatus resource describes the state of a Subscription during notifications.
- [Get history of SubscriptionStatus with identifier {identifier}](https://api-reference.oystehr.com/reference/get_subscriptionstatus-identifier-history.md): **[SubscriptionStatus on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptionstatus.html)** The SubscriptionStatus resource describes the state of a Subscription during notifications.
- [Get SubscriptionStatus with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_subscriptionstatus-identifier-history-versionidentifier.md): **[SubscriptionStatus on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptionstatus.html)** The SubscriptionStatus resource describes the state of a Subscription during notifications.
- [Search SubscriptionTopics](https://api-reference.oystehr.com/reference/get_subscriptiontopic.md): **[SubscriptionTopic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptiontopic.html)** Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
- [Create a new SubscriptionTopic](https://api-reference.oystehr.com/reference/post_subscriptiontopic.md): **[SubscriptionTopic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptiontopic.html)** Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic. The body should be a valid FHIR object for SubscriptionTopic. For example, if creating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`SubscriptionTopic`](https://www.hl7.org/fhir/r4b/SubscriptionTopic.html).
- [Search SubscriptionTopics](https://api-reference.oystehr.com/reference/post_subscriptiontopic-search.md): **[SubscriptionTopic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptiontopic.html)** Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
- [Get SubscriptionTopic with identifier {identifier}](https://api-reference.oystehr.com/reference/get_subscriptiontopic-identifier.md): **[SubscriptionTopic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptiontopic.html)** Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
- [Update SubscriptionTopic with identifier {identifier}](https://api-reference.oystehr.com/reference/put_subscriptiontopic-identifier.md): **[SubscriptionTopic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptiontopic.html)** Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic. The body should be a valid FHIR object for SubscriptionTopic. For example, if updating a [`Slot`](https://www.hl7.org/fhir/r4b/slot.html) resource, here is a valid object: ```json { "resourceType": "Slot", "schedule": { "reference": "schedule/a" }, "status": "free", "start": "2022-08-10T11:00:00Z", "end": "2022-08-10T12:00:00Z" } ``` You can reference the FHIR documentation to determine the format for [`SubscriptionTopic`](https://www.hl7.org/fhir/r4b/SubscriptionTopic.html).
- [Patch SubscriptionTopic with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_subscriptiontopic-identifier.md): **[SubscriptionTopic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptiontopic.html)** Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic. The body should be a list of valid JSON patches for SubscriptionTopic. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete SubscriptionTopic with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_subscriptiontopic-identifier.md): **[SubscriptionTopic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptiontopic.html)** Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
- [Get history of SubscriptionTopic with identifier {identifier}](https://api-reference.oystehr.com/reference/get_subscriptiontopic-identifier-history.md): **[SubscriptionTopic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptiontopic.html)** Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
- [Get SubscriptionTopic with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_subscriptiontopic-identifier-history-versionidentifier.md): **[SubscriptionTopic on the FHIR specification website.](https://www.hl7.org/fhir/r4b/subscriptiontopic.html)** Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
- [Search Substances](https://api-reference.oystehr.com/reference/get_substance.md): **[Substance on the FHIR specification website.](https://www.hl7.org/fhir/r4b/substance.html)** A homogeneous material with a definite composition.
- [Create a new Substance](https://api-reference.oystehr.com/reference/post_substance.md): **[Substance on the FHIR specification website.](https://www.hl7.org/fhir/r4b/substance.html)** A homogeneous material with a definite composition. The body should be a valid FHIR object for Substance. Here is an example: ```json { "resourceType": "Substance", "id": "example", "text": { "status": "generated", "div": "Generated Narrative with Details
id: example
identifier: 1463
status: active
category: Allergen (Details : {http://terminology.hl7.org/CodeSystem/substance-category code 'allergen' = 'Allergen', given as 'Allergen'})
code: apitoxin (Honey Bee Venom) (Details )
Generated Narrative with Details
id: example
identifier: 1463
status: active
category: Allergen (Details : {http://terminology.hl7.org/CodeSystem/substance-category code 'allergen' = 'Allergen', given as 'Allergen'})
code: apitoxin (Honey Bee Venom) (Details )
[Put rendering here]
" }, "identifier": [ { "value": "98398459409", "assigner": { "display": "SupplierDeliveryNr" } } ], "status": "in-progress", "patient": { "display": "Mr. Belpit" }, "supplier": { "display": "ACME distribution" }, "destination": { "display": "Home care dept" }, "receiver": [ { "display": "Nurse Smith" } ] } ``` You can reference the FHIR documentation to determine the format for [`SupplyDelivery`](https://www.hl7.org/fhir/r4b/SupplyDelivery.html).
- [Search SupplyDeliverys](https://api-reference.oystehr.com/reference/post_supplydelivery-search.md): **[SupplyDelivery on the FHIR specification website.](https://www.hl7.org/fhir/r4b/supplydelivery.html)** Record of delivery of what is supplied.
- [Get SupplyDelivery with identifier {identifier}](https://api-reference.oystehr.com/reference/get_supplydelivery-identifier.md): **[SupplyDelivery on the FHIR specification website.](https://www.hl7.org/fhir/r4b/supplydelivery.html)** Record of delivery of what is supplied.
- [Update SupplyDelivery with identifier {identifier}](https://api-reference.oystehr.com/reference/put_supplydelivery-identifier.md): **[SupplyDelivery on the FHIR specification website.](https://www.hl7.org/fhir/r4b/supplydelivery.html)** Record of delivery of what is supplied. The body should be a valid FHIR object for SupplyDelivery. Here is an example: ```json { "resourceType": "SupplyDelivery", "id": "pumpdelivery", "text": { "status": "generated", "div": "[Put rendering here]
" }, "identifier": [ { "value": "98398459409", "assigner": { "display": "SupplierDeliveryNr" } } ], "status": "in-progress", "patient": { "display": "Mr. Belpit" }, "supplier": { "display": "ACME distribution" }, "destination": { "display": "Home care dept" }, "receiver": [ { "display": "Nurse Smith" } ] } ``` You can reference the FHIR documentation to determine the format for [`SupplyDelivery`](https://www.hl7.org/fhir/r4b/SupplyDelivery.html).
- [Patch SupplyDelivery with identifier {identifier}](https://api-reference.oystehr.com/reference/patch_supplydelivery-identifier.md): **[SupplyDelivery on the FHIR specification website.](https://www.hl7.org/fhir/r4b/supplydelivery.html)** Record of delivery of what is supplied. The body should be a list of valid JSON patches for SupplyDelivery. For example, to update a Slot status to busy, this would be the body: ```json [ { op: 'replace', path: '/status', value: 'busy', }, ], ```
- [Delete SupplyDelivery with identifier {identifier}](https://api-reference.oystehr.com/reference/delete_supplydelivery-identifier.md): **[SupplyDelivery on the FHIR specification website.](https://www.hl7.org/fhir/r4b/supplydelivery.html)** Record of delivery of what is supplied.
- [Get history of SupplyDelivery with identifier {identifier}](https://api-reference.oystehr.com/reference/get_supplydelivery-identifier-history.md): **[SupplyDelivery on the FHIR specification website.](https://www.hl7.org/fhir/r4b/supplydelivery.html)** Record of delivery of what is supplied.
- [Get SupplyDelivery with identifier {identifier} at version {versionIdentifier}](https://api-reference.oystehr.com/reference/get_supplydelivery-identifier-history-versionidentifier.md): **[SupplyDelivery on the FHIR specification website.](https://www.hl7.org/fhir/r4b/supplydelivery.html)** Record of delivery of what is supplied.
- [Search SupplyRequests](https://api-reference.oystehr.com/reference/get_supplyrequest.md): **[SupplyRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/supplyrequest.html)** A record of a request for a medication, substance or device used in the healthcare setting.
- [Create a new SupplyRequest](https://api-reference.oystehr.com/reference/post_supplyrequest.md): **[SupplyRequest on the FHIR specification website.](https://www.hl7.org/fhir/r4b/supplyrequest.html)** A record of a request for a medication, substance or device used in the healthcare setting. The body should be a valid FHIR object for SupplyRequest. Here is an example: ```json { "resourceType": "SupplyRequest", "id": "simpleorder", "text": { "status": "generated", "div": "Generated Narrative with Details
id: simpleorder
identifier: Order10284
status: active
category: Central Stock Resupply (Details : {[not stated] code 'central' = 'central', given as 'Central Stock Resupply'})
priority: asap
item: Blood collect tubes blue cap (Details : {[not stated] code 'BlueTubes' = 'BlueTubes', given as 'Blood collect tubes blue cap'})
quantity: 10
occurrence: 31/12/2016
authoredOn: 31/12/2016
requester: Henry Seven
supplier: Vendor1
reasonCode: Refill due to low stock (Details : {[not stated] code 'stock_low' = 'stock_low', given as 'Refill due to low stock'})
deliverFrom: Location 1
deliverTo: GoodHealth Clinic Receiving
Generated Narrative with Details
id: simpleorder
identifier: Order10284
status: active
category: Central Stock Resupply (Details : {[not stated] code 'central' = 'central', given as 'Central Stock Resupply'})
priority: asap
item: Blood collect tubes blue cap (Details : {[not stated] code 'BlueTubes' = 'BlueTubes', given as 'Blood collect tubes blue cap'})
quantity: 10
occurrence: 31/12/2016
authoredOn: 31/12/2016
requester: Henry Seven
supplier: Vendor1
reasonCode: Refill due to low stock (Details : {[not stated] code 'stock_low' = 'stock_low', given as 'Refill due to low stock'})
deliverFrom: Location 1
deliverTo: GoodHealth Clinic Receiving
\n\t\t\t
The EHR Server supports the following transactions for the resource Person: read, vread, \n update, history, search(name,gender), create and updates.
\n\t\t\t
The EHR System supports the following message: admin-notify::Person.
\n\t\t\t
The EHR Application has a \n general document profile.\n
\n\t\t
\n\t\t\t
The EHR Server supports the following transactions for the resource Person: read, vread, \n update, history, search(name,gender), create and updates.
\n\t\t\t
The EHR System supports the following message: admin-notify::Person.
\n\t\t\t
The EHR Application has a \n general document profile.\n
\n\t\t
\n
AbstractType
\n
\n
A list of the base types defined by this version of the FHIR specification - types that are defined, but for which only specializations actually are created.
\n\n
\n
This value set includes codes from the following code systems:
\n
\n
\n
AbstractType
\n
\n
A list of the base types defined by this version of the FHIR specification - types that are defined, but for which only specializations actually are created.
\n\n
\n
This value set includes codes from the following code systems:
\n
\n
Generated Narrative with Details
id: example
status: attested
Generated Narrative with Details
id: example
status: attested
\n\t\t\t
OD -2.00 SPH +2.00 add 0.5 p.d. BD
\n\t\t\t
OS -1.00 -0.50 x 180 +2.00 add 0.5 p.d. BU
\n\t\t
\n\t\t\t
OD -2.00 SPH +2.00 add 0.5 p.d. BD
\n\t\t\t
OS -1.00 -0.50 x 180 +2.00 add 0.5 p.d. BU
\n\t\t