HealthcareService

HTTP Metode Endepunkt Beskrivelse
GET /HealthcareService/Id Henter HealthcareService med gitt Id
PUT /HealthcareService/Id Oppdaterer HealthcareService med gitt Id
DELETE /HealthcareService/Id Sletter HealthcareService med gitt Id
GET /HealthcareService Henter alle HealthcareServices
POST /HealthcareService Oppretter en ny HealthcareService
GET /HealthcareService/$LocationSearch Henter en HealthcareService med en gitt Locationid
GET /HealthcareService/$fullText Utfører et fulltextsøk basert på søkestrengen. Returnerer en bundle med helsetjenester samt deres lokasjoner som 'included'.

GET /HealthcareService/Id

Henter HealthcareService med gitt Id.

Parametre

Parameter Type Beskrivelse
id int Id-en til en helsetjeneste

Eksempel

Hent HealthcareService med Id 123:

GET /HealthcareService/123

Respons

{
  "id": "123",
  "resourceType": "HealthcareService",
  "name": "Trondheim helsestasjon for ungdom (HFU)",
  "meta": {
    "versionId": "AAAAAAAAyXI",
    "lastUpdated": "2025-01-16T07:22:47.342+00:00"
  },
  "active" : true,
  "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"
        }
      ]
    }
  ],
  "extraDetails": "Ekstra detaljer om helsetjenesten"
}

PUT /HealthcareService/Id

Oppdater en HealthcareService med gitt Id.

Headers

If-Match headeren må være spesifisert med en ETag.

Parametre

Parameter Type Beskrivelse
Id int Id-en til en helsetjeneste

Body

Kroppen i forespørselen tar inn en HealthcareService.

{
  "resourceType": "HealthcareService",
  "name": "Trondheim helsestasjon for ungdom",
  "type": [
    {
      "coding": [
        {
          "code": "KF01"
        }
      ]
    }
  ],
  "location": [
    {
      "reference": "Location/4"
    }
  ],
  "availability": [
    {
      "availableTime": [
        {
          "daysOfWeek": [
            "wed"
          ],
          "allDay": true
        },
        {
          "daysOfWeek": [
            "mon",
            "fri"
          ],
          "availableStartTime": "08:30:00",
          "availableEndTime": "15:30:00"
        }
      ]
    }
  ],
  "extraDetails": "Ekstra detaljer om helsetjenesten"
}

Eksempel

Oppdater HealthcareService med Id 123:

PUT /HealthcareService/123

Respons

{
  "id": "123",
  "resourceType": "HealthcareService",
  "name": "Trondheim helsestasjon for ungdom (HFU)",
  "meta": {
    "versionId": "AAAAAAAAyXI",
    "lastUpdated": "2025-01-16T07:22:47.342+00:00"
  },
  "active" : true,
  "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"
        }
      ]
    }
  ],
  "extraDetails": "Ekstra detaljer om helsetjenesten"
}

DELETE /HealtcareService/Id

Sletter en HealthcareService med gitt Id.

Parametre

Parameter Type Beskrivelse
Id int Id-en til en helsetjeneste

Eksempel

Slett HealthcareService med id 123:

DELETE /HealthcareService/123

Respons

{
  "resourceType": "HealthcareService",
  "id": "1",
  "active": false
}

GET /HealthcareService

Henter alle HealthcareServices.

Returnerer en Bundle med HealthcareServices.

Parametre

Parameter Type Beskrivelse
Page int Sidenummer
Size int Maks antall entries på hver side

Eksempel

GET /HealthcareService

Respons

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 3,
  "link": [
    {
      "relation": "self",
      "url": "https://locoreg.dev.grunndata.nhn.no/HealthcareService?Page=1&Size=2"
    },
    {
      "relation": "last",
      "url": "https://locoreg.dev.grunndata.nhn.no/HealthcareService?Page=2&Size=2"
    },
    {
      "relation": "next",
      "url": "https://locoreg.dev.grunndata.nhn.no/HealthcareService?Page=2&Size=2"
    },
    {
      "relation": "first",
      "url": "https://locoreg.dev.grunndata.nhn.no/HealthcareService?Page=1&Size=2"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/HealthcareService/1",
      "resource": {
        "resourceType": "HealthcareService",
        "id": "1",
        "active" : true,
        "name": "Midtbyen helsestasjon for ungdom",
        "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"
              }
            ]
          }
        ],
        "extraDetails": "Ekstra detaljer om helsetjenesten"
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/HealthcareService/2",
      "resource": {
        "resourceType": "HealthcareService",
        "id": "2",
        "active" : true,
        "name": "Øya helsestasjon for ungdom",
        "meta": {
          "versionId": "AAAAAAAAB9Y",
          "lastUpdated": "2024-08-15T10:58:03.352+00:00"
        },
        "type": [
          {
            "coding": [
              {
                "system": "https://fat.terminologi.ehelse.no/api/code-systems/adm/codelist/8663",
                "code": "KF0103",
                "display": "Helsestasjon for ungdom"
              }
            ]
          }
        ],
        "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"
              }
            ]
          }
        ],
        "extraDetails": "Ekstra detaljer om helsetjenesten"
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/HealthcareService/3",
      "resource": {
        "resourceType": "HealthcareService",
        "id": "3",
        "active" : true,
        "name": "Byåsen helsestasjon for ungdom",
        "meta": {
          "versionId": "AAAAAAAAB9c",
          "lastUpdated": "2024-08-15T11:02:03.016+00:00"
        },
        "type": [
          {
            "coding": [
              {
                "system": "https://fat.terminologi.ehelse.no/api/code-systems/adm/codelist/8663",
                "code": "KF0103",
                "display": "Helsestasjon for ungdom"
              }
            ]
          }
        ],
        "location": [
          {
            "reference": "https://locoreg.dev.grunndata.nhn.no/Location/1"
          }
        ],
        "availability": [
          {
            "availableTime": [
              {
                "daysOfWeek": [
                  "wed"
                ],
                "allDay": true
              },
              {
                "daysOfWeek": [
                  "mon",
                  "tue",
                  "thu",
                  "fri"
                ],
                "availableStartTime": "08:30:00",
                "availableEndTime": "15:30:00"
              }
            ]
          }
        ],
        "extraDetails": "Ekstra detaljer om helsetjenesten"
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST /HealthcareService

Oppretter en HealthcareService.

Body

Kroppen i forespørselen tar inn en HealthcareService.

{
  "resourceType": "HealthcareService",
  "name": "Trondheim helsestasjon for ungdom",
  "type": [
    {
      "coding": [
        {
          "code": "KF01"
        }
      ]
    }
  ],
  "location": [
    {
      "reference": "Location/4"
    }
  ],
  "availability": [
    {
      "availableTime": [
        {
          "daysOfWeek": [
            "wed"
          ],
          "allDay": true
        },
        {
          "daysOfWeek": [
            "mon",
            "fri"
          ],
          "availableStartTime": "08:30:00",
          "availableEndTime": "15:30:00"
        }
      ]
    }
  ],
  "extraDetails": "Ekstra detaljer om helsetjenesten"
}

Eksempel

POST /HealthcareService

Respons

{
  "id": "123",
  "resourceType": "HealthcareService",
  "name": "Trondheim helsestasjon for ungdom (HFU)",
  "meta": {
    "versionId": "AAAAAAAAyXI",
    "lastUpdated": "2025-01-16T07:22:47.342+00:00"
  },
  "active" : true,
  "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"
        }
      ]
    }
  ],
  "extraDetails": "Ekstra detaljer om helsetjenesten"
}

GET /HealthcareService/$LocationSearch

Søk etter HealthcareService basert på lokasjonens ID og eventuelt tjenestetype.

Parametre

Parameter Type Beskrivelse
id int Id-en til en lokasjon
hcsType (valgfri) string Kommaseparert liste av tjenestetypekoder. Per nå støttes kun KF01, KA02 og KF0103

Eksempel

Hvis vi henter id nummer 5 og hcsType KA02

Respons

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 3,
  "link": [
    {
      "relation": "self",
      "url": "https://locoreg.dev.grunndata.nhn.no/HealthcareService?Page=1&Size=2"
    },
    {
      "relation": "last",
      "url": "https://locoreg.dev.grunndata.nhn.no/HealthcareService?Page=2&Size=2"
    },
    {
      "relation": "next",
      "url": "https://locoreg.dev.grunndata.nhn.no/HealthcareService?Page=2&Size=2"
    },
    {
      "relation": "first",
      "url": "https://locoreg.dev.grunndata.nhn.no/HealthcareService?Page=1&Size=2"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/HealthcareService/1",
      "resource": {
        "resourceType": "HealthcareService",
        "id": "1",
        "active" : true,
        "name": "Midtbyen helsestasjon for ungdom",
        "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"
              }
            ]
          }
        ],
        "extraDetails": "Ekstra detaljer om helsetjenesten"
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/HealthcareService/2",
      "resource": {
        "resourceType": "HealthcareService",
        "id": "2",
        "active" : true,
        "name": "Øya helsestasjon for ungdom",
        "meta": {
          "versionId": "AAAAAAAAB9Y",
          "lastUpdated": "2024-08-15T10:58:03.352+00:00"
        },
        "type": [
          {
            "coding": [
              {
                "system": "https://fat.terminologi.ehelse.no/api/code-systems/adm/codelist/8663",
                "code": "KF0103",
                "display": "Helsestasjon for ungdom"
              }
            ]
          }
        ],
        "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"
              }
            ]
          }
        ],
        "extraDetails": "Ekstra detaljer om helsetjenesten"
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://locoreg.dev.grunndata.nhn.no/HealthcareService/3",
      "resource": {
        "resourceType": "HealthcareService",
        "id": "3",
        "active" : true,
        "name": "Byåsen helsestasjon for ungdom",
        "meta": {
          "versionId": "AAAAAAAAB9c",
          "lastUpdated": "2024-08-15T11:02:03.016+00:00"
        },
        "type": [
          {
            "coding": [
              {
                "system": "https://fat.terminologi.ehelse.no/api/code-systems/adm/codelist/8663",
                "code": "KF0103",
                "display": "Helsestasjon for ungdom"
              }
            ]
          }
        ],
        "location": [
          {
            "reference": "https://locoreg.dev.grunndata.nhn.no/Location/1"
          }
        ],
        "availability": [
          {
            "availableTime": [
              {
                "daysOfWeek": [
                  "wed"
                ],
                "allDay": true
              },
              {
                "daysOfWeek": [
                  "mon",
                  "tue",
                  "thu",
                  "fri"
                ],
                "availableStartTime": "08:30:00",
                "availableEndTime": "15:30:00"
              }
            ]
          }
        ],
        "extraDetails": "Ekstra detaljer om helsetjenesten"
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

GET /HealthcareService/$fullText

Søker etter HealthcareService basert på en søketekst.

Parametre

Parameter Type Beskrivelse
query string FullText søk på HealthcareService
page int Sidenummer
size int Maks antall entries på hver side

Eksempel

Hent en HealthcareService med parameter "Trondheim"

GET /HealthcareService/$fullText?Query=Alstahaug

Response

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://localhost:7153/HealthcareService/$fullText?Query=trondheim"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://localhost:7153/HealthcareService/5",
      "resource": {
        "resourceType": "HealthcareService",
        "id": "5",
        "meta": {
          "versionId": "AAAAAAABQF8",
          "lastUpdated": "2024-10-31T12:28:17.482+01:00"
        },
        "active": true,
        "type": [
          {
            "coding": [
              {
                "system": "https://fat.terminologi.ehelse.no/api/code-systems/adm/codelist/8663",
                "code": "KF01",
                "display": "Helsestasjons- og skolehelsetjeneste"
              }
            ]
          }
        ],
        "location": [
          {
            "reference": "https://localhost:7153/Location/4"
          }
        ],
        "name": "Trondheim helsestasjon for ungdom",
        "availability": [
          {
            "availableTime": [
              {
                "daysOfWeek": [
                  "wed"
                ],
                "allDay": true
              },
              {
                "daysOfWeek": [
                  "mon",
                  "fri"
                ],
                "availableStartTime": "08:30:00",
                "availableEndTime": "15:30:00"
              }
            ]
          }
        ],
        "extraDetails": "Ekstra detaljer om helsetjenesten"
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://localhost:7153/Location/4",
      "resource": {
        "resourceType": "Location",
        "id": "4",
        "status": "inactive"
      },
      "search": {
        "mode": "include"
      }
    }
  ]
}