GET api/v1/patients/{id}?domain={domain}&key={key}&provider_unit={provider_unit}&roles={roles}

Patient by the national identity number (fødselsnummer) or id

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The national identity number (DDMMYYXXXXX, e.g. 11118793456) or internal patient Id in EPJ	string	Required
domain	The domain ID. This is the name of the municipality's meta domain that the API is reading writing data to.	string	Required
key	The API license key.	string	Required
provider_unit	Not in use	string	None.
roles	Not in use	string	None.

Body Parameters

None.

Response Information

Resource Description

Patient by the national identity number (fødselsnummer) or id

Patient

Name	Description	Type	Additional information
Age	Calculated Age (years) of patient based on SSn.	integer	None.
IsSecretAddress	Specifies wether the address is secret or not	boolean	None.
IsSecretCommunication	Specifies if communication info (EMail, Phone etc is secret)	boolean	None.
HasElock	Specifies if Patient has Elock or not	boolean	None.
AccessRestriction	A list of persons which are not allowed to view this Patient	Collection of PatientAccessRestriction	None.
Id	PatientID. Same as Bruker in Gerica.	integer	None.
Ssn	National identity number (fødselsnummer)	string	None.
Name	Patient Name	Name	None.
Gender	Gets the gender from the Gerica Database. Can be "Female", "Male" or "Unknown"	string	None.
Nationality	Nationality (e.g. "Norsk"). Can be null	string	None.
Language	Language (e.g. "Norsk"). Can be null	string	None.
CityDistrict	CityDistrict	string	None.
CivilStatus	Civil Status: "Ugift", "Gift/samboer", "Separert/skilt", "Enke/-mann", "Ikke oppgitt"	string	None.
Address	Address. All parts can be null	Address	None.
CommunicationList	List of communication info like: Email addresses, phone numbers etc.	Collection of Communication	None.

Response Formats

application/json, text/json

Sample:

{
  "Age": 87,
  "IsSecretAddress": false,
  "IsSecretCommunication": true,
  "HasElock": true,
  "AccessRestriction": [
    {
      "RestrictionType": 1,
      "RestrictionDescription": "Ansatt skal IKKE se pasienten.",
      "StartDate": "2017-01-01T00:00:00",
      "EndDate": "0001-01-01T00:00:00",
      "AdditionalInformation": "Some information",
      "Employee": {
        "Id": 2,
        "Ssn": "121287909876",
        "Name": {
          "FirstName": null,
          "LastName": "Lastname, FirstName",
          "MiddleName": null
        },
        "Gender": null,
        "Nationality": null,
        "Language": null,
        "CityDistrict": null,
        "CivilStatus": null,
        "Address": null,
        "CommunicationList": null
      }
    },
    {
      "RestrictionType": 1,
      "RestrictionDescription": "",
      "StartDate": "2017-01-01T00:00:00",
      "EndDate": "0001-01-01T00:00:00",
      "AdditionalInformation": "Some information",
      "Employee": {
        "Id": 3,
        "Ssn": "121287909999",
        "Name": {
          "FirstName": null,
          "LastName": "Lastname2, FirstName2",
          "MiddleName": null
        },
        "Gender": null,
        "Nationality": null,
        "Language": null,
        "CityDistrict": null,
        "CivilStatus": null,
        "Address": null,
        "CommunicationList": null
      }
    }
  ],
  "Id": 61,
  "Ssn": "15109802345",
  "Name": {
    "FirstName": "Rino",
    "LastName": "Hauge",
    "MiddleName": null
  },
  "Gender": "Female",
  "Nationality": "Norsk",
  "Language": "Svensk",
  "CityDistrict": null,
  "CivilStatus": "Gift/samboer",
  "Address": {
    "StreetAddress": "Olav M. TroviksVei 50 H0104",
    "ZipCode": "0864",
    "City": "Testby"
  },
  "CommunicationList": [
    {
      "CommunicationType": "Adresse",
      "Value": "testveien 1",
      "IsMain": false
    },
    {
      "CommunicationType": "E-post",
      "Value": "Test@gmail.com",
      "IsMain": false
    }
  ]
}

application/xml, text/xml

Sample:

<Patient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://lifecare.tieto.com/ec/no/v1">
  <Address>
    <City>Testby</City>
    <StreetAddress>Olav M. TroviksVei 50 H0104</StreetAddress>
    <ZipCode>0864</ZipCode>
  </Address>
  <CityDistrict i:nil="true" />
  <CivilStatus>Gift/samboer</CivilStatus>
  <CommunicationList>
    <Communication>
      <CommunicationType>Adresse</CommunicationType>
      <IsMain>false</IsMain>
      <Value>testveien 1</Value>
    </Communication>
    <Communication>
      <CommunicationType>E-post</CommunicationType>
      <IsMain>false</IsMain>
      <Value>Test@gmail.com</Value>
    </Communication>
  </CommunicationList>
  <Gender>Female</Gender>
  <Id>61</Id>
  <Language>Svensk</Language>
  <Name>
    <FirstName>Rino</FirstName>
    <LastName>Hauge</LastName>
    <MiddleName i:nil="true" />
  </Name>
  <Nationality>Norsk</Nationality>
  <Ssn>15109802345</Ssn>
  <AccessRestriction>
    <PatientAccessRestriction>
      <AdditionalInformation>Some information</AdditionalInformation>
      <Employee>
        <Address i:nil="true" />
        <CityDistrict i:nil="true" />
        <CivilStatus i:nil="true" />
        <CommunicationList i:nil="true" />
        <Gender i:nil="true" />
        <Id>2</Id>
        <Language i:nil="true" />
        <Name>
          <FirstName i:nil="true" />
          <LastName>Lastname, FirstName</LastName>
          <MiddleName i:nil="true" />
        </Name>
        <Nationality i:nil="true" />
        <Ssn>121287909876</Ssn>
      </Employee>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <RestrictionDescription>Ansatt skal IKKE se pasienten.</RestrictionDescription>
      <RestrictionType>1</RestrictionType>
      <StartDate>2017-01-01T00:00:00</StartDate>
    </PatientAccessRestriction>
    <PatientAccessRestriction>
      <AdditionalInformation>Some information</AdditionalInformation>
      <Employee>
        <Address i:nil="true" />
        <CityDistrict i:nil="true" />
        <CivilStatus i:nil="true" />
        <CommunicationList i:nil="true" />
        <Gender i:nil="true" />
        <Id>3</Id>
        <Language i:nil="true" />
        <Name>
          <FirstName i:nil="true" />
          <LastName>Lastname2, FirstName2</LastName>
          <MiddleName i:nil="true" />
        </Name>
        <Nationality i:nil="true" />
        <Ssn>121287909999</Ssn>
      </Employee>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <RestrictionDescription></RestrictionDescription>
      <RestrictionType>1</RestrictionType>
      <StartDate>2017-01-01T00:00:00</StartDate>
    </PatientAccessRestriction>
  </AccessRestriction>
  <Age>87</Age>
  <HasElock>true</HasElock>
  <IsSecretAddress>false</IsSecretAddress>
  <IsSecretCommunication>true</IsSecretCommunication>
</Patient>