Location.md - NHN Utviklerportal

Location

HTTP Metode	Endepunkt	Beskrivelse
GET	/Location/`Id`	Henter Location med gitt Id
PUT	/Location/`Id`	Oppdaterer Location med gitt Id
DELETE	/Location/`Id`	Sletter Location med gitt Id
POST	/Location	Oppretter en ny Location
GET	/Location	Henter alle Locations
GET	/Location/$geoSearch	Henter Locations nær en gitt posisjon
GET	/Location/$orgSearch	Henter Locations som eies av et gitt orgnummer

GET /Location/`Id`

Henter Location med gitt Id.

Parametre

Parameter	Type	Beskrivelse
`Id`	int	Id-en til en location

Eksempel

Hent Location med Id 123:

GET /Location/123

Curl

curl -X 'GET' \
  'https://locoreg.dev.grunndata.nhn.no/Location/123' \
  -H 'accept: application/json'

PUT /Location/`Id`

Oppdater en Location med gitt Id.

Parametre

Parameter	Type	Beskrivelse
`Id`	int	Id-en til en location

Body

Kroppen i forespørselen tar inn en Location.

Eksempel

Oppdater Location med Id 123:

PUT /Location/123

{
  "resourceType": "Location",
  "name": "Orkdal Sykehus",
  "mode": "instance",
  "contact": [
    {
      "telecom": [
        {
          "system": "phone",
          "value": "12345667"
        }
      ]
    }
  ],
  "address": {
    "line": [
      "Sjukehusvegen 3"
    ],
    "city": "Bårdshaug",
    "postalCode": "7300"
  },
  "position": {
    "longitude": 9.8458529,
    "latitude": 63.2921677
  },
  "managingOrganization": {
    "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883974832"
  }
}

Curl

curl -X 'PUT' \
  'https://locoreg.dev.grunndata.nhn.no/Location/123' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name" : "Orkdal Sykehus",
  "mode" : "instance",
  "managingOrganization" : {
    "reference" : "Organization/933794261"
  },
  "contact" : [{
    "telecom" : [{
      "system" : "phone",
      "value" : "(+1) 734-677-7777"
    }]
  }],
  "address" : {
    "line" : ["3300 Washtenaw Avenue, Suite 227"],
    "city" : "Ann Arbor",
    "state" : "MI",
    "postalCode" : "48104",
    "country" : "Norge"
  },
  "position" : {
    "longitude" : 9.8458529,
    "latitude" : 63.2921677
  }
}'

DELETE /Location/`Id`

Sletter Location med gitt Id.

Parametre

Parameter	Type	Beskrivelse
`Id`	int	Id-en til lokasjonen som skal slettes

Eksempel

Slette Location med Id 123:

DELETE /Location/123

Curl

curl -X 'DELETE' \
  'https://locoreg.dev.grunndata.nhn.no/Location/123' \
  -H 'accept: application/json'

Post /Location

Oppretter en Location.

Body

Kroppen i forespørselen tar inn en Location. Id blir tildelt av server.

Eksempel

Opprett Location:

POST /Location

{
  "resourceType": "Location",
  "name": "Orkdal Sykehus",
  "mode": "instance",
  "contact": [
    {
      "telecom": [
        {
          "system": "phone",
          "value": "12345667"
        }
      ]
    }
  ],
  "address": {
    "line": [
      "Sjukehusvegen 3"
    ],
    "city": "Bårdshaug",
    "postalCode": "7300"
  },
  "position": {
    "longitude": 9.8458529,
    "latitude": 63.2921677
  },
  "managingOrganization": {
    "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883974832"
  }
}

GET /Location

Henter alle Locations.

Returnerer en Bundle med Locations i entriesene.

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 8,
  "link": [
    {
      "relation": "self",
      "url": "https://locoreg.dev.grunndata.nhn.no/Location"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/1",
      "resource": {
        "resourceType": "Location",
        "id": "1",
        "meta": {
          "versionId": "AAAAAAAAB9E",
          "lastUpdated": "2024-08-14T08:13:10.754+00:00"
        },
        "name": "Orkdal Sykehus",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "06800"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Sjukehusvegen 3"
          ],
          "city": "Bårdshaug",
          "postalCode": "7300"
        },
        "position": {
          "longitude": 9.8458529,
          "latitude": 63.2921677
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883974832"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/2",
      "resource": {
        "resourceType": "Location",
        "id": "2",
        "meta": {
          "versionId": "AAAAAAAAB9I",
          "lastUpdated": "2024-08-14T08:25:24.989+00:00"
        },
        "name": "Orkdal Sykehus",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "06800"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Sjukehusvegen 3"
          ],
          "city": "Bårdshaug",
          "postalCode": "7300"
        },
        "position": {
          "longitude": 9.8458529,
          "latitude": 63.2921677
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883974832"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/3",
      "resource": {
        "resourceType": "Location",
        "id": "3",
        "meta": {
          "versionId": "AAAAAAAAB9M",
          "lastUpdated": "2024-08-14T13:44:42.208+00:00"
        },
        "name": "Tromsø Sykehus",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "068069670"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Hansine Hansens veg 67"
          ],
          "city": "Tromsø",
          "postalCode": "9019"
        },
        "position": {
          "longitude": 18.980543,
          "latitude": 69.682994
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883974832"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/4",
      "resource": {
        "resourceType": "Location",
        "id": "4",
        "meta": {
          "versionId": "AAAAAAAAB9Q",
          "lastUpdated": "2024-08-15T10:46:53.889+00:00"
        },
        "name": "Alstahaug Helsestasjon",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "75075140"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Torolv Kveldulvsons gate 76"
          ],
          "city": "Sandnessjøen",
          "postalCode": "8800"
        },
        "position": {
          "longitude": 12.6199731826782,
          "latitude": 66.0186614990234
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883935632"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/5",
      "resource": {
        "resourceType": "Location",
        "id": "5",
        "meta": {
          "versionId": "AAAAAAAAB9g",
          "lastUpdated": "2024-08-15T11:10:03.046+00:00"
        },
        "name": "AVERØY HELSESTASJON",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "71 51 36 80"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Bruvollveien 4"
          ],
          "city": "Averøy",
          "postalCode": "6530"
        },
        "position": {
          "longitude": 7.6311388015747,
          "latitude": 63.0821914672852
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/976676556"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/6",
      "resource": {
        "resourceType": "Location",
        "id": "6",
        "meta": {
          "versionId": "AAAAAAAAB9o",
          "lastUpdated": "2024-08-15T11:40:15.066+00:00"
        },
        "name": "ALSTAHAUG KOMMUNE HELSESTASJONEN",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "75 07 51 40"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Torolv Kveldulvsons gate 76"
          ],
          "city": "ALSTAHAUG",
          "postalCode": "8800"
        },
        "position": {
          "longitude": 12.6199731826782,
          "latitude": 66.0186614990234
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883935632"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/7",
      "resource": {
        "resourceType": "Location",
        "id": "7",
        "meta": {
          "versionId": "AAAAAAAAB9w",
          "lastUpdated": "2024-08-15T11:50:34.625+00:00"
        },
        "name": "ARENDAL HELSESTASJON",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "02945867"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Arendal kommune Postboks 123"
          ],
          "city": "Arendal",
          "postalCode": "4891"
        },
        "position": {
          "longitude": 8.7634611129761,
          "latitude": 58.4594917297363
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/911967464"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/8",
      "resource": {
        "resourceType": "Location",
        "id": "8",
        "meta": {
          "versionId": "AAAAAAAAB94",
          "lastUpdated": "2024-08-15T12:02:45.619+00:00"
        },
        "name": "Aukra Helsestasjon",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "71171430"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Aukraringen 17"
          ],
          "city": "AUKRA",
          "postalCode": "6480"
        },
        "position": {
          "longitude": 6.8861494064331,
          "latitude": 62.8056144714356
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/983837352"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

GET /Location/$geoSearch

Søker etter Locations i nærheten av gitte koordinater, maks avstand fra koordinatene og kan begrenses til å kun returnere Locations som har gitte helsetjenestetyper.

Returnerer en Bundle med Locations og HealthcareServices i entriesene. Om man kun ønsker Locations kan de filtreres på entries som har SearchEntryMode satt til Match.

Les mer om FHIR-søk her.

Parametre

Parameter	Type	Beskrivelse
`Latitude`	double	Breddegrad
`Longitude`	double	Lengdegrad
`hcsType`	string	Kommaseparert liste av tjenestetypekoder. Per nå støttes kun KF01, KA02 og KF0103
`maxDistanceInMeters`	int	Maks avstand fra koordinatene

Eksempel

Hent Locations med koordinater 0, 0 og maks avstand 1000 meter, denne vil returnere lokasjoner med alle helsetjenestetyper:

GET /Location/$geoSearch?latitude=0&longitude=0&maxDistanceInMeters=1000

Curl

curl -X 'GET' \
  'https://locoreg.dev.grunndata.nhn.no/Location/$geoSearch?latitude=0&longitude=0&maxDistanceInMeters=1000' \
  -H 'accept: application/json'

Respons

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://locoreg.dev.grunndata.nhn.no/Location/$geoSearch?latitude=9.8458529&longitude=63.2921677&hcsType=KF01&maxDistanceInMeters=1000000000"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/4",
      "resource": {
        "resourceType": "Location",
        "id": "4",
        "meta": {
          "versionId": "AAAAAAAAB9Q",
          "lastUpdated": "2024-08-15T10:46:53.889+00:00"
        },
        "name": "Alstahaug Helsestasjon",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "75075140"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Torolv Kveldulvsons gate 76"
          ],
          "city": "Sandnessjøen",
          "postalCode": "8800"
        },
        "position": {
          "longitude": 12.6199731826782,
          "latitude": 66.0186614990234
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883935632"
        }
      },
      "search": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/location-distance",
            "valueDistance": {
              "value": 7311761.461781,
              "unit": "m"
            }
          }
        ],
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/HealthcareService/1",
      "resource": {
        "resourceType": "HealthcareService",
        "id": "1",
        "name": "midtbyen helsestasjon for ungdom",
        "active" : true,
        "meta": {
          "versionId": "AAAAAAAAJxo",
          "lastUpdated": "2024-08-27T14:41:35.926+00:00"
        },
        "type": [
          {
            "coding": [
              {
                "system": "https://fat.terminologi.ehelse.no/api/code-systems/adm/codelist/8663",
                "code": "KF01",
                "display": "Helsestasjons- og skolehelsetjeneste"
              }
            ]
          }
        ],
        "location": [
          {
            "reference": "https://locoreg.dev.grunndata.nhn.no/Location/4"
          }
        ],
        "availability": [
          {
            "availableTime": [
              {
                "daysOfWeek": [
                  "wed"
                ],
                "allDay": true
              },
              {
                "daysOfWeek": [
                  "mon",
                  "tue",
                  "thu",
                  "fri"
                ],
                "availableStartTime": "08:30:00",
                "availableEndTime": "15:30:00"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "include"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/HealthcareService/10",
      "resource": {
        "resourceType": "HealthcareService",
        "name": "øya helsestasjon for ungdom",
        "id": "10",
        "active" : true,
        "meta": {
          "versionId": "AAAAAAAAJxI",
          "lastUpdated": "2024-08-16T07:56:06.017+00:00"
        },
        "type": [
          {
            "coding": [
              {
                "system": "https://fat.terminologi.ehelse.no/api/code-systems/adm/codelist/8663",
                "code": "KF01",
                "display": "Helsestasjons- og skolehelsetjeneste"
              }
            ]
          }
        ],
        "location": [
          {
            "reference": "https://locoreg.dev.grunndata.nhn.no/Location/4"
          }
        ],
        "availability": [
          {
            "availableTime": [
              {
                "daysOfWeek": [
                  "wed"
                ],
                "allDay": true
              },
              {
                "daysOfWeek": [
                  "mon",
                  "tue",
                  "thu",
                  "fri"
                ],
                "availableStartTime": "08:30:00",
                "availableEndTime": "15:30:00"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "include"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/HealthcareService/11",
      "resource": {
        "resourceType": "HealthcareService",
        "active" : true,
        "id": "11",
        "name": "Byåsen helsestasjon for ungdom",
        "meta": {
          "versionId": "AAAAAAAAJxQ",
          "lastUpdated": "2024-08-20T14:06:21.233+00:00"
        },
        "type": [
          {
            "coding": [
              {
                "system": "https://fat.terminologi.ehelse.no/api/code-systems/adm/codelist/8663",
                "code": "KF01",
                "display": "Helsestasjons- og skolehelsetjeneste"
              }
            ]
          }
        ],
        "location": [
          {
            "reference": "https://locoreg.dev.grunndata.nhn.no/Location/4"
          }
        ],
        "availability": [
          {
            "availableTime": [
              {
                "daysOfWeek": [
                  "wed"
                ],
                "allDay": true
              },
              {
                "daysOfWeek": [
                  "mon",
                  "fri"
                ],
                "availableStartTime": "08:30:00",
                "availableEndTime": "15:30:00"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "include"
      }
    }
  ]
}

GET /Location/$orgSearch

Søker etter Locations som eies av en gitt organisasjon.

Returnerer en Bundle med Locations i entriesene.

Parametre

Parameter	Type	Beskrivelse
`organization`	string	Organisasjonsnummer for ønskede lokasjoner

Eksempel

Hent Locations som ligger under organisasjonsnummer 123456789:

GET /Location/$geoSearch?organization=123456789

Curl

curl -X 'GET' \
  'https://locoreg.dev.grunndata.nhn.no/Location/$geoSearch?organization=123456789' \
  -H 'accept: application/json'

Respons

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://locoreg.dev.grunndata.nhn.no/Location/$orgSearch?organization=883935632"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/4",
      "resource": {
        "resourceType": "Location",
        "id": "4",
        "meta": {
          "versionId": "AAAAAAAAB9Q",
          "lastUpdated": "2024-08-15T10:46:53.889+00:00"
        },
        "name": "Alstahaug Helsestasjon",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "75075140"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Torolv Kveldulvsons gate 76"
          ],
          "city": "Sandnessjøen",
          "postalCode": "8800"
        },
        "position": {
          "longitude": 12.6199731826782,
          "latitude": 66.0186614990234
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883935632"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/Location/6",
      "resource": {
        "resourceType": "Location",
        "id": "6",
        "meta": {
          "versionId": "AAAAAAAAB9o",
          "lastUpdated": "2024-08-15T11:40:15.066+00:00"
        },
        "name": "ALSTAHAUG KOMMUNE HELSESTASJONEN",
        "mode": "instance",
        "status": "active",
        "contact": [
          {
            "telecom": [
              {
                "system": "phone",
                "value": "75 07 51 40"
              }
            ]
          }
        ],
        "address": {
          "line": [
            "Torolv Kveldulvsons gate 76"
          ],
          "city": "ALSTAHAUG",
          "postalCode": "8800"
        },
        "position": {
          "longitude": 12.6199731826782,
          "latitude": 66.0186614990234
        },
        "managingOrganization": {
          "reference": "https://orgreg.dev.grunndata.nhn.no/Organization/883935632"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Location

GET /Location/Id

Parametre

Eksempel

Curl

PUT /Location/Id

Parametre

Body

Eksempel

Curl

DELETE /Location/Id

Parametre

Eksempel

Curl

Post /Location

Body

Eksempel

GET /Location

GET /Location/$geoSearch

Parametre

Eksempel

Curl

Respons

GET /Location/$orgSearch

Parametre

Eksempel

Curl

Respons

GET /Location/`Id`

PUT /Location/`Id`

DELETE /Location/`Id`