Skip to content

Konformitetskrav

Jump to bottom
Espen Stranger Seland edited this page Sep 17, 2019 · 1 revision

Denne seksjonen beskriver konformitetskravene HelseAPI tjenere og HelseAPI klienter. Identifiserer hvilke profiler, RESTful operasjoner og søkeparametere som MÅ støttes. NB: De individuelle HelseAPI profilene setter krav til strukturelle begrensninger og terminologibindinger.

Konformitetskrav for HelseAPI tjenere

  • FHIR versjon: 4.0.0
  • Støttede formater: xml, json
  • Publisert: (en-eller-annen-dato)
  • Publisert av: HL7 Norge - Teknisk styringskommité

Denne seksjonen beskriver de forventede kapabilitetene til en HelseAPI tjener som skal sørge for å svare på forespørsler fra HelseAPI klienter.

Oppførsel

Beskrivelse:

HelseAPI tjenere SKAL:

  • Støtte ressursprofilen HelseAPI Patient.
  • Implementere RESTful-oppførsel slik den er beskrevet i FHIR spesifikasjonen.
  • Kunne returnere følgende HTTP-statuskoder
    • 200 - OK: Operasjonen var en suksess
    • 400 - Bad Request: Ressursen kan ikke parses eller feilet en eller flere valideringsregler
    • 401 - Unauthorized: Forespørselen manglet nødvendig autorisasjon
    • 404 - Not Found: Ressurstypen støttes ikke / endepunktet eksisterer ikke
    • 410 - Gone: Ressursen er slettet
  • Støtte ressursformatet json for alle HelseAPI interaksjoner.
  • Deklarere en CapabilityStatement som identifiserer profiler, operasjoner og søkeparametere som HelseAPI tjeneren støtter.

HelseAPI tjenere BURDE:

  • Støtte ressursformatet xml for alle HelseAPI interaksjoner.
  • Angi hvilken HelseAPI profil tjeneren konformer til ved å angi FHIR meta.profile attributtet for hver instans.

Sikkerhet

HelseAPI tjenere SKAL:

  • Implementere sikkerhetskravene slik de er dokumentert i seksjonen .
  • Sikre at hver API-forespørsel inkluderer en gyldig Authorization token: Authorization: Bearer {server-specific-token-here}
  • Avvise uautoriserte forespørsler ved å returnere en HTTP 401 Unauthorized eller 404 Not Found statuskode i henhold til seksjonen som omhandler responshåndtering ved tilgangsnekt.

Profilinteraksjon

  • HelseAPI tjenere SKAL tilgjengeliggjøre interaksjonene read og search.
  • HelseAPI tjenere BURDE tilgjengeliggjøre interaksjonene vread og history-instance.

Søkeparametere

Ressurstype Støttede profiler Støttede søk
Patient identifier, name, family, given, gender, birthdate, name + gender, name + birthdate, family + gender, given + gender
Practitioner identifier, name
Organization identifier, name, address

Patient

Profiler: 

Interaksjoner og søkekriterier:

  1. En HelseAPI tjener SKAL kunne returnere en pasient ved hjelp av følgende interaksjon:
    GET [base]/Patient/[id]
  2. En HelseAPI tjener SKAL kunne returnere en pasient ved hjelp av en identifikator:
    POST [base]/Patient?identifier=[system]|[code]
  3. En HelseAPI tjener SKAL kunne returnere en pasient når et minimum av 2 av følgende søkeparametere er samtidig tilstede:
    • name
    • gender
    • birthdate
      • F.eks:
        GET [base]/Patient?name=[string]&gender=[token]

Søkeparametere:

Konformitet Parameter Type
SKAL identifier token
SKAL name string
SKAL family + gender string + token
SKAL given + gender string + token
SKAL name + gender string + token
SKAL name + birthdate string + date

Practitioner

Profiler: 

Interaksjoner og søkekriterier:

  1. En HelseAPI tjener SKAL kunne returnere et helsepersonell ved hjelp av følgende interaksjon:
    GET [base]/Practitioner/[id]
  2. En HelseAPI tjener SKAL kunne returnere et helsepersonell ved hjelp av en identifikator:
    POST [base]/Practitioner?identifier=[system]|[code]
  3. En HelseAPI tjener SKAL kunne returnere et helsepersonell ved hjelp av et navn:
    GET [base]/Practitioner?family=[string]&given=[string]

Søkeparametere:

Konformitet Parameter Type
SKAL identifier token
SKAL name string

Organization

Profiler: 

Interaksjoner og søkekriterier:

  1. En HelseAPI tjener SKAL kunne returnere en organisasjon ved hjelp av følgende interaksjon:
    GET [base]/Organization/[id]
  2. En HelseAPI tjener SKAL kunne returnere en organisasjon ved hjelp av en identifikator:
    GET [base]/Organization?identifier=[system]|[code]
  3. En HelseAPI tjener SKAL kunne returnere en organisasjon ved hjelp av et navn:
    GET [base]/Organization?name=[string]
  4. En HelseAPI tjener BURDE kunne returnere en organisasjon ved hjelp av en adresse:
    GET [base]/Organization?address=[string]

Søkeparametere:

Konformitet Parameter Type
SKAL identifier token
SKAL name string
BURDE address string

Konformitetskrav for HelseAPI klienter

  • FHIR versjon: 4.0.0
  • Støttede formater: xml, json
  • Publisert: (en-eller-annen-dato)
  • Publisert av: HL7 Norge - Teknisk styringskommité

Denne seksjonen beskriver de forventede kapabilitetene til en HelseAPI klient som er ansvarlig for å opprette og initiere forespørsler om informasjon for en gitt pasient. Den komplette listen av FHIR profiler, RESTful interaksjoner og søkeparametre støttet av HelseAPI tjenere er beskrevet i seksjonen Konformitetskrav for HelseAPI tjenere.

Oppførsel

Beskrivelse:

HelseAPI klienten BURDE:

  • Støtte uthenting og forespørsler av en eller flere av HelseAPI profilene ved å bruke RESTful interaksjoner og søkeparametere beskrevet i HelseAPI tjenerens CapabilityStatement.

Sikkerhet:

HelseAPI klienten SKAL:

  • Implementere de sikkerhetskrav som er beskrevet i seksjonen .

Patient

Profiler: 

Interaksjoner og søkekriterier:

  1. En klient BURDE kunne utføre en forespørsel om en pasient ved hjelp av følgende interaksjon:
    GET [base]/Patient/[id]
  2. En klient BURDE kunne utføre en forespørsel om en pasient ved hjelp av en identifikator:
    POST: [base]/Patient?identifier=[system]|[code]
  3. En klient BURDE kunne utføre en forespørsel om en pasient ved å benytte ett minimum av 2 søkeparametere. For å unngå for brede søk, BURDE f.eks. et søk på kjønn inkludere etternavn og fornavn.
    • name
    • gender
    • birthdate
      • F.eks:
        GET [base]/Patient=family=[string]&given=[string]&gender=[token]

Practitioner

Profiler: 

Interaksjoner og søkekriterier:

  1. En klient BURDE kunne utføre en forespørsel om et helsepersonell ved hjelp av følgende interaksjon:
    GET [base]/Practitioner/[id]
  2. En klient BURDE kunne utføre en forespørsel om et helsepersonell ved hjelp av en identifikator:
    POST [base]/Practitioner?identifier=[system]|[code]
  3. En klient BURDE kunne utføre en forespørsel om et helsepersonell ved hjelp av et navn:
    POST [base]/Practitioner?family=[string]&given=[string]

Organization

Profiler: 

Interaksjoner og søkekriterier:

  1. En klient BURDE kunne utføre en forespørsel om en organisasjon ved hjelp av følgende interaksjon:
    GET [base]/Organization/[id]
  2. En klient BURDE kunne utføre en forespørsel om en organisasjon ved hjelp av en identifikator:
    GET [base]/Organization?identifier=[system]|[code]
  3. En klient BURDE kunne utføre en forespørsel om en organisasjon ved hjelp av et navn:
    GET [base]/Organization?name=[string]
  4. En klient BURDE kunne utføre en forespørsel om en organisasjon ved hjelp av adresse:
    GET [base]/Organization?address=[string]
Clone this wiki locally