/
HelseAPI DocumentReference

HelseAPI DocumentReference

Denne profilen identifiserer ett sett med minimumsforventninger til en http://hl7.org/fhir/R4/documentreference.html-ressurs, ved registrering, søk og uthenting av pasientrelaterte dokumenter. Den definerer hvilke kjerneelementer, utvidelser, vokabularer og kodeverk som SKAL være til stede når man benytter denne profilen. I tillegg til denne profilen anbefales det å lese Veiledning kliniske notater.

Eksempelscenarioer:

  • Forespørsel om alle dokumenter/notater som hører til en pasient

  • Forespørsel om en spesifikk type notat eller kategori

  • Skrive nytt dokument/notat til pasientens journal

Obligatoriske elementer og terminologi

Følgende dataelementer er obligatoriske.

Hver enkelt DocumentReference må ha:

  1. En status

  2. En dokumentkategori

  3. En kode som beskriver type dokument

  4. En relasjon til en pasient eller et helsepersonell

  5. MIME-typen til dokumentet (content-type)

  6. En adresse (URL) hvor dokumentet kan hentes eller der innholdet er inline base64-kodet

Dersom data er tilgjengelig, skal DocumentReference inkludere:

  1. Dato og tid referansen ble opprettet

  2. En eller flere forfattere

  3. Organisasjonen som er ansvarlig for dokumentet

  4. En kode som spesifiserer dokumentformatet, utover innholdets MIME-type

  5. Referanse til pasientens konsultasjon

  6. Klinisk relevant dato

Profilspesifikk implementeringsveiledning

Detaljert sammendrag

Detaljert sammendrag

Sammendrag av obligatoriske krav

  1. En code i DocumentReference.status med en binding til http://hl7.org/fhir/ValueSet/document-reference-status

  2. En eller flere CodeableConcepts i DocumentReference.category med en http://hl7.org/fhir/R4/terminologies.html#extensible binding til ValueSet - NO HelseAPI DocumentReference Category

  3. En CodeableConcept i DocumentReference.type med en http://hl7.org/fhir/R4/terminologies.html#required binding til ValueSet - NO HelseAPI DocumentReference Type

  4. En referanse til en Patient- eller Practitioner-ressurs i DocumentReference.subject

    1. som SKAL referere til Patient- eller Practitioner-ressursen på en av to måter:

      1. Reference.reference, en faktisk referanse til en Patient-ressurs, relativ eller absolutt URL

      2. Reference.identifier, en logisk referanse. Ved integrasjon på tvers av virksomheter vil en logisk referanse ofte være det riktige valget. Når man benytter logisk referanse, skal Reference.type angi type ressurs.

  5. Dokumentinnholdet i DocumentReference.content

    1. som SKAL ha en Attachment-verdi i DocumentReference.content.attachment

      1. som SKAL ha en code-verdi i DocumentReference.content.attachment.contentType med en http://hl7.org/fhir/R4/terminologies.html#required binding til http://hl7.org/fhir/valueset-mimetypes.html.

      2. som BØR ha referanse til en Binary-referanse i DocumentReference.content.attachment.url

      3. som BØR ha en base64Binary-verdi i DocumentReference.content.attachment.data

    2. som BØR ha en Coding-verdi i DocumentReference.content.format med en http://hl7.org/fhir/R4/terminologies.html#extensible binding til http://hl7.org/fhir/valueset-formatcodes.html

Sammendrag av “må støttes”-krav

  1. En instant i DocumentReference.date

  2. En eller flere Author-referanser i DocumentReference.author

  3. En eller flere referanser til Organization angitt som forvaltere i DocumentReference.custodian

  4. En klinisk kontekst angitt i DocumentReference.context

    1. som KAN ha en referanse til en Encounter i DocumentReference.context.encounter

    2. som KAN ha en Period-verdi i DocumentReference.context.period

Obligatoriske og anbefalte RESTful-interaksjoner

Nedenfor finner du en oversikt over de RESTful FHIR-interaksjonene som er påkrevd – for eksempel søk og leseoperasjoner – for denne profilen. Se samsvarskrav for en komplett liste over støttede RESTful-interaksjoner.

GET [base]/DocumentReference/[id]

Eksempel: GET [base]/DocumentReference/4346

Støtte: Obligatorisk

Implementeringsnotater: Henter en enkelt DocumentReference-ressurs. Selve dokumentet er representert som et base64-kodet binært dataelement i DocumentReference.content.attachment.data eller hentes via lenken angitt i DocumentReference.content.attachment.url. Dersom dokumentet er en relativ lenke til en Binary-ressurs, kan den senere hentes via API-endepunktet: GET [base]/Binary/[id].

---------------------------

POST [base]/DocumentReference

Eksempel: POST [base]/DocumentReference

Støtte: Obligatorisk

Implementeringsnotater: Oppretter en enkelt DocumentReference-ressurs. Selve dokumentet er representert via lenken angitt i DocumentReference.content.attachment.url eller som et base64-kodet binært dataelement i DocumentReference.content.attachment.data. Når dokumentet er en relativ lenke til en Binary-ressurs, skal ressursen på forhånd ha vært skrevet til API-endepunktet: POST [base]/Binary.
Ved vellykket opprettelse av ressursen og påfølgende respons SKAL Location-headeren være satt og inneholde http://hl7.org/fhir/R4/resource.html#metadata og http://hl7.org/fhir/R4/resource.html#metadata. I tillegg anbefales det å returnere den opprettede ressursen i sin helhet, inkl. ID- og meta-attributtene. Se ellers seksjonene http://hl7.org/fhir/R4/http.html#ops og http://hl7.org/fhir/R4/http.html#create i FHIR-spesifikasjonen.

--------------------------

GET [base]/DocumentReference?patient=[id]

Eksempel:

GET [base]/DocumentReference?patient=504202

Støtte: Obligatorisk

Implementeringsnotater: Henter ett sett med DocumentReference-ressurser for den spesifiserte pasienten. Se implementeringsnotater over for hvordan det faktiske dokumentet kan aksesseres.

--------------------------

GET [base]/DocumentReference?patient=[id]&type={[system]}|[code]

Eksempel:

GET [base]/DocumentReference?patient=504202&type=http://snomed.info/sct|371529009

Støtte: Obligatorisk

Implementeringsnotater: Henter ett sett med DocumentReference-ressurser for den spesifiserte pasienten og typen dokument. Se implementeringsnotater over for hvordan det faktiske dokumentet kan aksesseres.