GET API/V1/Patients

Request Information

URI Parameters

Name	Description	Type	Additional information
MyList	Filter by my list flag. (Example: MyList=true)	boolean	None.
PatientSetId	Filter by a specific MetaVision PatientSet id. (Example: PatientSetId=151)	integer	None.
PatientSet	Filter by a specific MetaVision PatientSet name. (Example: PatientSet=Cardiac)	string	None.
IncludeTracking	Choose whether to include the patient tracking of each patient or not. See Tracking for further details.	boolean	None.
FirstName	Filter by patient's first name. Returns patients with a string containing the specified string. For example, a request for patients with LastName=Smi&FirstName=Jo will return John Smith.	string	None.
LastName	Filter by patient's last name. Returns patients with a string containing the specified string. For example, a request for patients with LastName=Smi&FirstName=Jo will return John Smith.	string	None.
IsExactSearchAccountNumber		boolean	None.
AccountNumber	Filter by all account numbers matching the specified string.	string	None.
IsExactSearchMRNumber		boolean	None.
MRNumber	Filter by all medical record numbers matching the specified string.	string	None.
AdmissionDateAfter	Find patients with an admission date & time later than or equal to the specified time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).	date	None.
AdmissionDateBefore	Find patients with an admission date & time earlier than or equal to the specified time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).	date	None.
DischargeDateAfter	Find patients with a discharge date & time later than or equal to the specified time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).	date	None.
DischargeDateBefore	Find patients with a discharge date & time date & time earlier than or equal to the specified time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).	date	None.
LastUpdateDateSince	Filters the list of patients to those who were last updated on or after the specified date & time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).	date	None.
Status	Filter the list of patients to see those who are currently in the specified status. Multiple statuses can be specified. Valid statuses are: Pre-admission \| Admission \| Pre-Op \| Intra-Op \| Post-Op \| Released \| Closed. Example: Status=Admission,Intra-Op	string	None.
Bed	Filter the list of patients to see those who are currently in the beds returned by the bed filter options specified. The bed can be specified by the exact MetaVision ID, and/or the external code containing the specified string, and/or description containing the specified string. Examples: Tracking.Bed.id=124 Tracking.Bed.code=12345^10^Bed1 Tracking.Bed.Description=Bed1	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Department	Filter the list of patients to see those who are currently in the departments returned by the department filter options specified. The department can be specified by the exact MetaVision ID, and/or the external code containing the specified string, and/or description containing the specified string. Examples: Tracking.Department.Id=123 Tracking.Department.Code=12345 Tracking.Department.Description=ICU	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
MRG	Filter the list of patients to see those who are currently in the MRG returned by the MRG filter options specified. The MRG can be specified by the exact MetaVision ID, and/or the external code containing the specified string, and/or description containing the specified string.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
CareTeam	Filter the list of patients to see those who currently belong to the specified care teams returned by the care team filter options specified. The care team can be specified by the exact MetaVision ID, and/or the external code containing the specified string, and/or description containing the specified string. Examples: CareTeam.Id=124 CareTeam.Code=7966 CareTeam.Description=Cardiac	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Tracking	Filter the list of patients according to patient tracking detail options. Filtering options include the following: a StartTime or EndTime before or after a specified date & time \| Status \| Department coded elements \| Bed coded elements.	iMDsoft.API.Metavision.Data.Patients.TrackingMetaData	None.

Body Parameters

None.

Response Information

Resource Description

Collection of iMDsoft.API.Metavision.Data.Patients.PatientModelEntity

Name	Description	Type	Additional information
PatientID	Unique patient ID in MetaVision. When posting, affects whether a patient file is registered or updated.	integer	None.
FirstName	The patient's first name. (Maximum number of characters: 400).	string	None.
LastName	The patient's last name. (Maximum number of characters: 400).	string	None.
MRNumber	The patient's medical record number. When posting, can only be updated if the PatientID is also being sent. Otherwise, the post attempts to either register a new patient or update an existing patient.	string	None.
AccountNumber	The patient's account number. When posting, can only be updated if the PatientID is also being sent. Otherwise, the post attempts to either register a new patient or update an existing patient.	string	None.
AdmissionDate	When getting, returns the patient's first active status date, or first status date (if there is no active status). Not used in post.	date	None.
ClosedDate	When getting, returns the patient's latest Closed status date. Not used in post.	date	None.
DOB	The patient's birth date. Specified in MetaVision Customization via system mappings to a Date & time parameter.	date	None.
Gender	The patient's gender. Specified in MetaVision Customization via system mappings to a text parameter.	string	None.
Status	The patient's current status. One of the following: Pre-admission \| Admission \| Pre-Op \| Intra-Op \| Post-Op \| Released \| Closed. When posting, please note that available statuses are limited by MetaVision Customization.It is also not possible to register a new patient file in the status Closed.	string	None.
StatusFromTime	The date and time of the current status as a RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). When posting, this value cannot be earlier than the first LocationFromTime.When the patient's status changes, the StatusFromTime should also be changed to reflect the time of that change.	date	None.
Department	The patient's current department. When posting, changing the department value together with the LocationFromTime changes the patient's department starting from the specified LocationFromTime. If the department is unrecognized, the patient's status is changed to Released or Closed. (It is changed to Closed if the status of Released is not allowed in the patient's existing department). If the department is recognized, the patient is either transferred to it (if it is in the same Medical Record Group and recognized as a MetaVision department), or transported to it (if it is a recognized transport destination), or released from the current department and registered in the new one (if it is recognized as a MetaVision department in a different Medical Record Group).	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
MRG	The patient's current MRG.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Bed	The patient's current bed (if any). If blank, the patient is not currently in a bed. When posting, the bed may or may not be mandatory depending on the customization settings. Changing the bed value together with the LocationFromTime changes the bed of the patient starting from the LocationFromTime.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
BedGroup	The bed group that the patients bad is in.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
BedFromTime	The date and time of the current bed as a RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). Not used in post. (Post uses LocationFromTime)	date	None.
LocationFromTime	When getting, returns the date and time of the current department. When posting, sets the date and time of the latest change made to the patient's bed or department. It cannot be earlier than the first StatusFromTime. Expressed as a RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).	date	None.
Comments	Any comments entered for the patient file.	string	None.
Tracking	When getting, returns the history of the patient file's departments, beds, statuses, transport, and times. Not used in post.	Collection of iMDsoft.API.Metavision.Data.Patients.Location	None.
CareTeam	The primary care team currently responsible for the patient.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
CareTeamFromTime	The start date and time for the current primary care team being assigned to the patient as a RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).	date	None.
DoNotTransferToArchive	In post, sets the status of the "Do not transfer to archive" flag in the patient file. In get, returns the status of the flag. Any patient file with this flag set to true is not transferred to the MetaVision archive database.	boolean	None.
Links	List of url links	Collection of iMDsoft.API.Metavision.Data.Patients.Link	None.
PersonID	Represents person ID	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "patientID": 1,
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "mrNumber": "sample string 3",
    "accountNumber": "sample string 4",
    "admissionDate": "2024-11-07T02:44:29.6243039+02:00",
    "closedDate": "2024-11-07T02:44:29.6243039+02:00",
    "dob": "2024-11-07T02:44:29.6243039+02:00",
    "gender": "sample string 5",
    "status": "sample string 6",
    "statusFromTime": "2024-11-07T02:44:29.6243039+02:00",
    "department": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "mrg": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "bed": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "bedGroup": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "bedFromTime": "2024-11-07T02:44:29.6243039+02:00",
    "locationFromTime": "2024-11-07T02:44:29.6243039+02:00",
    "comments": "sample string 7",
    "tracking": [
      {
        "startTime": "2024-11-07T02:44:29.6243039+02:00",
        "endTime": "2024-11-07T02:44:29.6243039+02:00",
        "status": "sample string 2",
        "department": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "bed": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "transport": true,
        "updateTime": "2024-11-07T02:44:29.6243039+02:00"
      },
      {
        "startTime": "2024-11-07T02:44:29.6243039+02:00",
        "endTime": "2024-11-07T02:44:29.6243039+02:00",
        "status": "sample string 2",
        "department": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "bed": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "transport": true,
        "updateTime": "2024-11-07T02:44:29.6243039+02:00"
      }
    ],
    "careTeam": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "careTeamFromTime": "2024-11-07T02:44:29.6243039+02:00",
    "doNotTransferToArchive": true,
    "links": [
      {
        "type": "sample string 1",
        "url": "sample string 2"
      },
      {
        "type": "sample string 1",
        "url": "sample string 2"
      }
    ],
    "personID": "sample string 8"
  },
  {
    "patientID": 1,
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "mrNumber": "sample string 3",
    "accountNumber": "sample string 4",
    "admissionDate": "2024-11-07T02:44:29.6243039+02:00",
    "closedDate": "2024-11-07T02:44:29.6243039+02:00",
    "dob": "2024-11-07T02:44:29.6243039+02:00",
    "gender": "sample string 5",
    "status": "sample string 6",
    "statusFromTime": "2024-11-07T02:44:29.6243039+02:00",
    "department": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "mrg": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "bed": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "bedGroup": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "bedFromTime": "2024-11-07T02:44:29.6243039+02:00",
    "locationFromTime": "2024-11-07T02:44:29.6243039+02:00",
    "comments": "sample string 7",
    "tracking": [
      {
        "startTime": "2024-11-07T02:44:29.6243039+02:00",
        "endTime": "2024-11-07T02:44:29.6243039+02:00",
        "status": "sample string 2",
        "department": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "bed": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "transport": true,
        "updateTime": "2024-11-07T02:44:29.6243039+02:00"
      },
      {
        "startTime": "2024-11-07T02:44:29.6243039+02:00",
        "endTime": "2024-11-07T02:44:29.6243039+02:00",
        "status": "sample string 2",
        "department": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "bed": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "transport": true,
        "updateTime": "2024-11-07T02:44:29.6243039+02:00"
      }
    ],
    "careTeam": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "careTeamFromTime": "2024-11-07T02:44:29.6243039+02:00",
    "doNotTransferToArchive": true,
    "links": [
      {
        "type": "sample string 1",
        "url": "sample string 2"
      },
      {
        "type": "sample string 1",
        "url": "sample string 2"
      }
    ],
    "personID": "sample string 8"
  }
]