GET Clients/MedicationEntry

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludeError	boolean	None.
Match	MatchCriteriaStringType	None.
ClientMedicationEntries	Collection of integer	None.
ClientID	integer	None.
ClientMedications	Collection of integer	None.
MedicationCategory	MedicationCategory	None.
AdministeredOnUtcMin	date	None.
AdministeredOnUtcMax	date	None.
AdministeredBy	MedicationAdministeredBy	None.
IsAdministered	boolean	None.
Props	Collection of Object	None.
Comments	string	None.
RecordState	ClinicalRecordState	None.
RecordStateReason	string	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ClientMedicationEntryDTO

Name	Type	Additional information
ClientMedicationEntryID	integer	None.
ClientMedicationID	integer	None.
MedicationCategory	MedicationCategory	None.
AdministeredOnUtc	date	None.
AdministeredBy	MedicationAdministeredBy	None.
IsAdministered	boolean	None.
Props	Collection of Object	None.
Comments	string	None.
RecordState	ClinicalRecordState	None.
RecordStateReason	string	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "clientMedicationEntryID": 1,
    "clientMedicationID": 2,
    "medicationCategory": 1,
    "administeredOnUtc": "2024-12-04T07:49:12.4492167+00:00",
    "administeredBy": 1,
    "isAdministered": true,
    "comments": "sample string 5",
    "recordState": 1,
    "recordStateReason": "sample string 6",
    "createdByUserID": 1,
    "lastUpdatedByUserID": 1,
    "created": {
      "dateUtc": "2024-12-04T07:49:12.4492167+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:49:12 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:49:12.4492167+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:49:12 AM"
    }
  },
  {
    "clientMedicationEntryID": 1,
    "clientMedicationID": 2,
    "medicationCategory": 1,
    "administeredOnUtc": "2024-12-04T07:49:12.4492167+00:00",
    "administeredBy": 1,
    "isAdministered": true,
    "comments": "sample string 5",
    "recordState": 1,
    "recordStateReason": "sample string 6",
    "createdByUserID": 1,
    "lastUpdatedByUserID": 1,
    "created": {
      "dateUtc": "2024-12-04T07:49:12.4492167+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:49:12 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:49:12.4492167+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:49:12 AM"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientMedicationEntryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ClientMedicationEntryDTO>
    <AdministeredBy>Provider</AdministeredBy>
    <AdministeredOnUtc>2024-12-04T07:49:12.4492167+00:00</AdministeredOnUtc>
    <ClientMedicationEntryID>1</ClientMedicationEntryID>
    <ClientMedicationID>2</ClientMedicationID>
    <Comments>sample string 5</Comments>
    <Created>
      <DateUtc>2024-12-04T07:49:12.4492167+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>1</CreatedByUserID>
    <IsAdministered>true</IsAdministered>
    <LastUpdated>
      <DateUtc>2024-12-04T07:49:12.4492167+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>1</LastUpdatedByUserID>
    <MedicationCategory>Medication</MedicationCategory>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
    <RecordStateReason>sample string 6</RecordStateReason>
  </ClientMedicationEntryDTO>
  <ClientMedicationEntryDTO>
    <AdministeredBy>Provider</AdministeredBy>
    <AdministeredOnUtc>2024-12-04T07:49:12.4492167+00:00</AdministeredOnUtc>
    <ClientMedicationEntryID>1</ClientMedicationEntryID>
    <ClientMedicationID>2</ClientMedicationID>
    <Comments>sample string 5</Comments>
    <Created>
      <DateUtc>2024-12-04T07:49:12.4492167+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>1</CreatedByUserID>
    <IsAdministered>true</IsAdministered>
    <LastUpdated>
      <DateUtc>2024-12-04T07:49:12.4492167+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>1</LastUpdatedByUserID>
    <MedicationCategory>Medication</MedicationCategory>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
    <RecordStateReason>sample string 6</RecordStateReason>
  </ClientMedicationEntryDTO>
</ArrayOfClientMedicationEntryDTO>

application/x-compressed-json

Sample:

��R1N1����-�(�IA����e�"Kg;���(��(x_�N(�H4)=3;;k����뎚�A�Xg4����~A�\����N#�c���z\FH`C��**��#.FL����3�ŵ�3�'�+�c�t������H�J��}ɓ�o�~�ɘ\X�����d��$:X��@�S�2eAY[gH�Ս�Xo��T�hG�`[<��AQ��z���͑c9�V�ޛ�Wt����K�.-�s�޾�Ou��