POST API/V1/Patients/Patient

Request Information

URI Parameters

None.

Body Parameters

iMDsoft.API.Metavision.Data.Patients.PatientModelEntity

Name	Type	Additional information
PatientID	integer	None.
FirstName	string	None.
LastName	string	None.
MRNumber	string	None.
AccountNumber	string	None.
AdmissionDate	date	None.
ClosedDate	date	None.
DOB	date	None.
Gender	string	None.
Status	string	None.
StatusFromTime	date	None.
Department	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
MRG	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Bed	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
BedGroup	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
BedFromTime	date	None.
LocationFromTime	date	None.
Comments	string	None.
Tracking	Collection of iMDsoft.API.Metavision.Data.Patients.Location	None.
CareTeam	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
CareTeamFromTime	date	None.
DoNotTransferToArchive	boolean	None.
Links	Collection of iMDsoft.API.Metavision.Data.Patients.Link	None.
PersonID	string	None.

Request 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-09-22T13:28:52.0303102+03:00",
  "closedDate": "2024-09-22T13:28:52.0303102+03:00",
  "dob": "2024-09-22T13:28:52.0303102+03:00",
  "gender": "sample string 5",
  "status": "sample string 6",
  "statusFromTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00",
  "locationFromTime": "2024-09-22T13:28:52.0303102+03:00",
  "comments": "sample string 7",
  "tracking": [
    {
      "startTime": "2024-09-22T13:28:52.0303102+03:00",
      "endTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00"
    },
    {
      "startTime": "2024-09-22T13:28:52.0303102+03:00",
      "endTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00"
    }
  ],
  "careTeam": {
    "id": 1,
    "code": "sample string 1",
    "description": "sample string 2"
  },
  "careTeamFromTime": "2024-09-22T13:28:52.0303102+03:00",
  "doNotTransferToArchive": true,
  "links": [
    {
      "type": "sample string 1",
      "url": "sample string 2"
    },
    {
      "type": "sample string 1",
      "url": "sample string 2"
    }
  ],
  "personID": "sample string 8"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PatientModelEntity'.

Response Information

Resource Description

iMDsoft.API.Metavision.Data.Patients.PatientsResult

Name	Type	Additional information
Results	Collection of iMDsoft.API.Metavision.Data.Patients.PatientModelEntity	None.
TotalPatientCount	integer	None.
LastPatientId	integer	None.
Success	boolean	None.
ValidationErrors	Collection of iMDsoft.API.Metavision.Data.Patients.ValidationError	None.

Response Formats

application/json, text/json

Sample:

{
  "results": [
    {
      "patientID": 1,
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "mrNumber": "sample string 3",
      "accountNumber": "sample string 4",
      "admissionDate": "2024-09-22T13:28:52.0303102+03:00",
      "closedDate": "2024-09-22T13:28:52.0303102+03:00",
      "dob": "2024-09-22T13:28:52.0303102+03:00",
      "gender": "sample string 5",
      "status": "sample string 6",
      "statusFromTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00",
      "locationFromTime": "2024-09-22T13:28:52.0303102+03:00",
      "comments": "sample string 7",
      "tracking": [
        {
          "startTime": "2024-09-22T13:28:52.0303102+03:00",
          "endTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00"
        },
        {
          "startTime": "2024-09-22T13:28:52.0303102+03:00",
          "endTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00"
        }
      ],
      "careTeam": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "careTeamFromTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00",
      "closedDate": "2024-09-22T13:28:52.0303102+03:00",
      "dob": "2024-09-22T13:28:52.0303102+03:00",
      "gender": "sample string 5",
      "status": "sample string 6",
      "statusFromTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00",
      "locationFromTime": "2024-09-22T13:28:52.0303102+03:00",
      "comments": "sample string 7",
      "tracking": [
        {
          "startTime": "2024-09-22T13:28:52.0303102+03:00",
          "endTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00"
        },
        {
          "startTime": "2024-09-22T13:28:52.0303102+03:00",
          "endTime": "2024-09-22T13:28:52.0303102+03: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-09-22T13:28:52.0303102+03:00"
        }
      ],
      "careTeam": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "careTeamFromTime": "2024-09-22T13:28:52.0303102+03:00",
      "doNotTransferToArchive": true,
      "links": [
        {
          "type": "sample string 1",
          "url": "sample string 2"
        },
        {
          "type": "sample string 1",
          "url": "sample string 2"
        }
      ],
      "personID": "sample string 8"
    }
  ],
  "totalPatientCount": 1,
  "lastPatientId": 2,
  "success": true,
  "validationErrors": [
    {
      "description": "sample string 1",
      "type": 0,
      "errorCode": 2
    },
    {
      "description": "sample string 1",
      "type": 0,
      "errorCode": 2
    }
  ]
}