POST api/patients/{patientid}/actions/filter

Retrieves the actions belonging to patient that meets the search criteria. Must have a valid Authorization header.

Request Information

URI Parameters

Name	Description	Type	Additional information
patientid	The patient id	integer	Required

Body Parameters

The action search criteria. Note Manufacturer ID is NOT IMPLEMENTED

ActionFilter

Name	Description	Type	Additional information
ActionsToReturn	Specify which actions is returned e.g. all or only the first. All = 0 (default), Latest, = 1 (newest with respect to create day)	integer	None.
ModuleIDs	Returns all actions which are created with one of the Module ids in the given array. If the array is empty no filtering on module id is applied.	Collection of integer	None.
ManufacturerID	NOT USED: Returns all actions which are created with the ManufacturerID. If -1 is empty no filtering on manufacturerID id is applied.	integer	None.
DataType	Returns all actions of the given data type. If -1 is empty no filtering on data type is applied.	integer	None.
ActionGroup	Return all actions in the given action group. If string is empty no filtering on action group is applied. The Actiongroup to be found. (Format : yyyy-MM-ddTHH:mm:ssZ)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ActionsToReturn": 1,
  "ModuleIDs": [
    1,
    2
  ],
  "ManufacturerID": 2,
  "DataType": 3,
  "ActionGroup": "sample string 4"
}

application/xml, text/xml

Sample:

<ActionFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
  <ActionGroup>sample string 4</ActionGroup>
  <ActionsToReturn>1</ActionsToReturn>
  <DataType>3</DataType>
  <ManufacturerID>2</ManufacturerID>
  <ModuleIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ModuleIDs>
</ActionFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The actions that meets the search criteria and belonging to a patient

Collection of Action

Name	Description	Type	Additional information
Id	Get the ID of the Action. Controlled by Noah. Set 0 when calling NewAction.	integer	None.
ActionGUID	Get the GUID of the Action.	globally unique identifier	None.
SessionID	Get the session ID that the action belongs to. Controlled by Noah. Set 0 when calling NewAction.	integer	None.
CreateDate	Get the date of creation. (Format : yyyy-MM-ddTHH:mm:ssZ). Controlled by Noah	string	None.
ModuleID	The ID of the module that created the Action. (Is composed as Hi word ManufactuerID and low word ModuleID).	integer	None.
Description	The Modules description of the Action (min. 1, max. 64 characters).	string	None.
DataTypeCode	The DataType of the Action.	integer	None.
DataFmtStd	The Standard format for the Public Data.	integer	None.
DataFmtExt	A module specific value. (Could be format of private data).	integer	None.
ActionGroup	The datetime of the ActionGroup that the action belongs to. (Format yyyy-MM-ddTHH:mm:ssZ) (Empty string is no actiongroup).	string	None.
DeviceType	DeviceType of the action.	integer	None.
LastModifiedDate	The date when the action was last modified. (Format : yyyy-MM-ddTHH:mm:ssZ). Controlled by Noah	string	None.
UserInitials	UserInitials of the user that created the action. (max 3 characters) ??? if not found. Controlled by Noah.	string	None.
ActionReferences	Action references.	Collection of integer	None.
PublicData	PublicData. Content only returned in GetAction. Otherwise this wil be null. When using New or Put Action to add the following rules apply. If publicData is null nothing are done to the public data in the database. If publicData is byte[0] the public data will be deleted from the database. else publicData are put to the database.	Collection of byte	None.
PrivateData	PrivateData. Content only returned in GetAction. Otherwise this wil be null. When using New or Put Action to add the following rules apply. If PrivateData is null nothing are done to the public data in the database. If PrivateData is byte[0] the public data will be deleted from the database. else PrivateData are put to the database.	Collection of byte	None.
ActionGroupGUID	ActionGroupGUID. The Guid is a unique identification of group of actions. Controlled by Noah.	globally unique identifier	None.
UserGUID	UserGUID. The Guid is a unique identification of a user. Controlled by Noah.	globally unique identifier	None.
PatientGUID	Patient Guid. The guid is a unique identification of the object/record in the database together with a patient id.. Controlled by Noah. When calling NewAction and UpdateAction this value must be set from the Patient object received from Noah when selecting a patient. In the following work flow patient data is not necessary to copy. Call GetAction edit the action and Update the action.	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "ActionGUID": "b56f2905-6948-4027-a60d-df30464e32f7",
    "SessionID": 3,
    "CreateDate": "sample string 4",
    "ModuleID": 5,
    "Description": "sample string 6",
    "DataTypeCode": 7,
    "DataFmtStd": 8,
    "DataFmtExt": 9,
    "ActionGroup": "sample string 10",
    "DeviceType": 11,
    "LastModifiedDate": "sample string 12",
    "UserInitials": "sample string 13",
    "ActionReferences": [
      1,
      2
    ],
    "PublicData": "QEA=",
    "PrivateData": "QEA=",
    "ActionGroupGUID": "bbffda50-66ec-48b8-9fa2-9091d3dcd88f",
    "UserGUID": "19fa54b4-fcaf-4124-adac-73cdbebc0496",
    "PatientGUID": "1de3e78d-9a7a-47bd-9d50-421013d944dc"
  },
  {
    "Id": 1,
    "ActionGUID": "b56f2905-6948-4027-a60d-df30464e32f7",
    "SessionID": 3,
    "CreateDate": "sample string 4",
    "ModuleID": 5,
    "Description": "sample string 6",
    "DataTypeCode": 7,
    "DataFmtStd": 8,
    "DataFmtExt": 9,
    "ActionGroup": "sample string 10",
    "DeviceType": 11,
    "LastModifiedDate": "sample string 12",
    "UserInitials": "sample string 13",
    "ActionReferences": [
      1,
      2
    ],
    "PublicData": "QEA=",
    "PrivateData": "QEA=",
    "ActionGroupGUID": "bbffda50-66ec-48b8-9fa2-9091d3dcd88f",
    "UserGUID": "19fa54b4-fcaf-4124-adac-73cdbebc0496",
    "PatientGUID": "1de3e78d-9a7a-47bd-9d50-421013d944dc"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
  <Action>
    <PatientGUID>1de3e78d-9a7a-47bd-9d50-421013d944dc</PatientGUID>
    <ActionGUID>b56f2905-6948-4027-a60d-df30464e32f7</ActionGUID>
    <ActionGroup>sample string 10</ActionGroup>
    <ActionGroupGUID>bbffda50-66ec-48b8-9fa2-9091d3dcd88f</ActionGroupGUID>
    <ActionReferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ActionReferences>
    <CreateDate>sample string 4</CreateDate>
    <DataFmtExt>9</DataFmtExt>
    <DataFmtStd>8</DataFmtStd>
    <DataTypeCode>7</DataTypeCode>
    <Description>sample string 6</Description>
    <DeviceType>11</DeviceType>
    <Id>1</Id>
    <LastModifiedDate>sample string 12</LastModifiedDate>
    <ModuleID>5</ModuleID>
    <PrivateData>QEA=</PrivateData>
    <PublicData>QEA=</PublicData>
    <SessionID>3</SessionID>
    <UserGUID>19fa54b4-fcaf-4124-adac-73cdbebc0496</UserGUID>
    <UserInitials>sample string 13</UserInitials>
  </Action>
  <Action>
    <PatientGUID>1de3e78d-9a7a-47bd-9d50-421013d944dc</PatientGUID>
    <ActionGUID>b56f2905-6948-4027-a60d-df30464e32f7</ActionGUID>
    <ActionGroup>sample string 10</ActionGroup>
    <ActionGroupGUID>bbffda50-66ec-48b8-9fa2-9091d3dcd88f</ActionGroupGUID>
    <ActionReferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ActionReferences>
    <CreateDate>sample string 4</CreateDate>
    <DataFmtExt>9</DataFmtExt>
    <DataFmtStd>8</DataFmtStd>
    <DataTypeCode>7</DataTypeCode>
    <Description>sample string 6</Description>
    <DeviceType>11</DeviceType>
    <Id>1</Id>
    <LastModifiedDate>sample string 12</LastModifiedDate>
    <ModuleID>5</ModuleID>
    <PrivateData>QEA=</PrivateData>
    <PublicData>QEA=</PublicData>
    <SessionID>3</SessionID>
    <UserGUID>19fa54b4-fcaf-4124-adac-73cdbebc0496</UserGUID>
    <UserInitials>sample string 13</UserInitials>
  </Action>
</ArrayOfAction>