Introduktion

Formål

Denne guide har til formål at give anvendere et overblik af NAP SDK'et, dets indhold og dets anvendelse.

Anvendere af NAP-SDK er primært projektudviklere, hvilket betyder at denne guide er egnet til dem.

Der foreligger desuden anvendelseseksempler. På baggrund af følgende eksempler, er det muligt at komme hurtigt i gang med anvendelsen af SDK'erne. 

Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for NAP SDK.

Dokumentet er udformet, så det i videst muligt omfang opfylder sit formål uafhængigt af de øvrige dokumenter.

Ønskes mere information omkring arkitektur og design findes dette på NAP SDK - Design og Arkitektur beskrivelse.

Ønskes mere information omkring installationsvejledning til anvendere findes dette på NAP SDK - Installationsvejledning.

Nap-typescript-sdk

Nap-typescript-sdk er det basale SDK. Det udstiller en række metoder og interfaces som bliver beskrevet nedenfor. 

• Et NAP interface, som fungerer som en wrapper omkring NAP bridge (NAP SDK - Design og Arkitektur beskrivelse).
• Et NAP message interface, som er den modellen for alle beskeder, som kan sendes over NAP. Disse beskeder er meget inspireret af FHIRcast.
• Et NAPEventCatalogue, der definere events inspireret af FHIRCast
• Hjælpemetoder til at sende og formatere beskeder.

NAP interface

En wrapper af NAP Bridge, som et værtssytem ligger på global scope af den embeddede browser. 

export interface NAP {
	fromHost$: Observable<NAPMessage>;
	toHost$: Subject<NAPMessage>;
	errors$: Observable<NAPError>;
	subscribe: (subscriber: NAPHostSubscriber) => void; 
	unsubscribe: (subscriber: NAPHostSubscriber) => void; 
	send: (message: NAPMessage) => void;
}

...

Denne wrapping foregår i createNAP() funktion, som SDKet eksporterer. En NAP bro kan således fanges gennem sdket ved et simpel kald:

import { createNAP, NAP} from "nap-typescript-sdk";
const nap:Nap = createNAP();

NAPMessage

Den grundlæggende model for nap beskeder, der kører over (fromHost$, toHost$, subscribe og send).

Består af følgende felter, hvor context propertien, er meget inspireret af FHIR / FHIRcast (https://fhircast.org/specification/Feb2020Ballot/).

export interface NAPMessage {

// FORMAT
  date: string;

// FORMAT
  id: string;

  event: NAPEvent;
}
export interface NAPEvent {
  type: NAPEventType;
  context?: FHIR.Context[];
}
export interface Context {
    resource?: {
        resourceType: string;
        meta?: Meta;
        code?: {
            coding: Coding[];
        };
        name?: Name[];
        identifier?: Identifier[];
        extension?: Extension[];
    };
}
export interface Name {
    family: string;
    given: string[];
}
export interface Extension {
    url: string;
    value: string;
}
export interface Identifier {
    system: string;
    value: string;
}
export interface Coding {
    system: string;
    code: string;
}
export interface Meta {
    profile: string[];
}

Eventkataloget definerer de eventtyper, der kan sendes over NAP i en given version.

Der er fortaget en minimal implementation af FHIR for at kunne opfylde nedenstående eventkatalog.

Hvis ikke beskeden opfylder

...

Dette eventkatalog lægger sig op af FHIR / FHIRcast.

...

Eventkatalog version 1

...

WebAppOpen

...

Sendes udelukkende fra lobbyen. Anvendes når en bruger vælger en afprøvningsløsning i lobbyen

...

NAP projektet er ikke aktivt og NAP er derfor ikke pt. under support og vedligehold.
NAP er ikke opdateret til at understøtte MitID/NemLogin3 og det er derfor ikke længere
muligt at anvende den nuværende version på testmiljøerne.
En evt. genoptagelse af NAP projektet vil afhænge af konkret efterspørgsel.
Kontakt evt. Sundhedsdatastyrelsen ved interesse i NAP.

Introduktion

Formål

Denne guide har til formål at give anvendere et overblik af NAP SDK'et, dets indhold og dets anvendelse.

Anvendere af NAP-SDK er primært projektudviklere, hvilket betyder at denne guide er egnet til dem.

Der foreligger desuden anvendelseseksempler. På baggrund af følgende eksempler, er det muligt at komme hurtigt i gang med anvendelsen af SDK'erne. 

Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for NAP SDK.

Dokumentet er udformet, så det i videst muligt omfang opfylder sit formål uafhængigt af de øvrige dokumenter.

Ønskes mere information omkring arkitektur og design findes dette på NAP SDK - Design og Arkitektur beskrivelse.

Ønskes mere information omkring installationsvejledning til anvendere findes dette på NAP SDK - Installationsvejledning.

Nap-typescript-sdk

Nap-typescript-sdk er det basale SDK. Det udstiller en række metoder og interfaces som bliver beskrevet nedenfor. 

• Et NAP interface, som fungerer som en wrapper omkring NAP bridge (NAP SDK - Design og Arkitektur beskrivelse).
• Et NAP message interface, som er modellen for alle beskeder, som kan sendes over NAP. Disse beskeder er meget inspireret af FHIRcast.
• Et NAPEventCatalogue, der definerer events inspireret af FHIRCast
• Hjælpemetoder til at sende og formatere beskeder.

NAP interface

En wrapper af NAP Bridge, som et værtssystem ligger på global scope af den embeddede browser. 

export interface NAP {
	fromHost$: Observable<NAPMessage>;
	toHost$: Subject<NAPMessage>;
	errors$: Observable<NAPError>;
	subscribe: (subscriber: NAPHostSubscriber) => void; 
	unsubscribe: (subscriber: NAPHostSubscriber) => void; 
	send: (message: NAPMessage) => void;
}

Denne wrapping foregår i createNAP() funktion, som SDKet eksporterer. En NAP bro kan således fanges gennem sdket ved et simpel kald:

import { createNAP, NAP} from "nap-typescript-sdk";
const nap:NAP = createNAP();

NAPMessage

Den grundlæggende model for nap beskeder, der kører over (fromHost$, toHost$, subscribe og send).

Består af følgende felter, hvor context propertien, er meget inspireret af FHIR / FHIRcast (https://fhircast.org/specification/Feb2020Ballot/).

export interface NAPMessage {
  date: string;
  id: string;
  event: NAPEvent;
}
export interface NAPEvent {
  type: NAPEventType;
  context?: FHIR.Context[];
}
export interface Context {
    resource?: {
        resourceType: string;
        meta?: Meta;
        code?: {
            coding: Coding[];
        };
        name?: Name[];
        identifier?: Identifier[];
        extension?: Extension[];
    };
}
export interface Name {
    family: string;
    given: string[];
}
export interface Extension {
    url: string;
    valueString?: string;
    valueBoolean?: boolean;
    valueDate?: Date;
    valueStringArray?: string[];
}
export interface Identifier {
    system: string;
    value: string;
}
export interface Coding {
    system: string;
    code: string;
}
export interface Meta {
    profile: string[];
}

Eventkataloget definerer de eventtyper, der kan sendes over NAP i en given version.

Der er foretaget en minimal implementation af FHIR for at kunne opfylde nedenstående eventkatalog.

NAPMassage Dataformat

Dataformaterne er inspireret af FHIRCast. I SDKet sker der tjek på at følgende felter opfylder dataformatet:

I tilfældet af en besked ikke opfylder dataformatet sendes en fejlbesked på error$ (stream med error beskeder), som de indlejrede system kan lytte på.
Se nedenfor, hvordan denne error stream kan anvendes.

Eventkatalog

Dette eventkatalog lægger sig op af FHIR / FHIRcast. Der forekommer en naturlig udvidelse af FHIR / FHIRcast standarden i form af de events der kommunikerer selektion/retrieve/filtering af NAPProjekter.

Som i FHIRCast definerer eventtypen dataformatet. Eksempler på disse events er illustreret nedenfor.

Dog er WebAppSelected, ProjectsRetrieved og ProjectsFiltered  ikke beskrevet i dette dokument, da disse events er tilegnet kommunikation mellem lobby og værtssystem. Du kan finde mere information om disse events på NAP Platform - Guide til anvendere.

Eksempel på anvendelse af eventkatalog version 1: 

import { NAPEventCatalogue } from 'nap-typescript-sdk';
const sessionCloseEvent = NAPEventCatalogue.v1.SessionClose;

NAPError

Interface for SDK fejl. Disse beskeder emittes af errors$ i tilfælde af initialiseringsfejl, hvis sker der fejl i createNAP() kaldet når NAP bridge skal wrappes, eller i tilfælde ar marshalling fejl, hvis en besked ikke overholder dataformatet. Se evt. NAPMessage Dataformat ovenfor. 

export interface NAPError {
  id: number;
  message: string;
  isFatal: boolean;
}

Eksempel på brug af errors$

Fejl bliver således skrevet i web konsollen.

this.napAngular.errors$.subscribe(res => {
     console.error(res);
    });

Eksemplet er taget fra NapRefWeb Referenceimplementering (NAP) - Leverancebeskrivelse.

Hjælpefunktioner

Nap-typescript-sdk indeholder derudover en række hjælpefunktioner, som kan være brugbare til at hente værdier og generere NAPMessages.

Komplet liste over hjælpefunktioner:

Nap-Message-Factory

Funktioner der gør det lettere at generere NAPMessages.

Eksempel på anvendelse af message factory

Som i FHIRCast definerer eventtypen dataformatet. Eksempler på disse events er illustreret nedenfor.

Dog er WebAppOpen ikke beskrevet i dette dokument, da dette event er tilegnet kommunikation lobby-værtssytem. Du kan finde mere information om dette event på NAP Platform - Guide til anvendere.

...

Code Block
language js
import { NAPEventCatalogue NAPEventCatalogue, NAPMessage } from 'nap-typescript-sdk'; import { v4 as UUID } from 'uuid'; const napMessageCurrentPatient = NAPEventCatalogue.v1.MessageFactory.createPatientOpenMessage(UUID()) const sessionCloseEventnapMessageSessionClose = NAPEventCatalogue.v1.SessionClose;

NAPError

Model for de SDK fejl. Disse beskeder sendes, hvis sker der fejl i createNAP() kaldet -  når NAP bridge skal wrappes.

export interface NAPError {
  id: number;
  message: string;
  isFatal: boolean;
}

Eksempel på brug af errors$

Fejl bliver således skrevet i web konsollen.

this.napAngular.errors$.subscribe(res => {
     console.error(res);
    });

Eksemplet er taget fra NapRefWeb Referenceimplementering (NAP) - Leverancebeskrivelse.

Hjælpefunktioner

Nap-typescript-sdk indeholder derudover en række hjælpefunktioner, som kan være brugbare til at hente værdier eller undgå stavefejl, når der skal laves NAPMessages.

Komplet liste over hjælpefunktioner:

...

getSessionValue(napMessage: NAPMessage): string | undefined

...

Henter samlAssertion. Returnerer undefined, hvis ikke data kan formateres.

...

filterEvent(type: string): Observable<NAPMessage>

...

MessageFactory.createSessionCloseMessage(UUID());
const napMessageSessionError = NAPEventCatalogue.v1.MessageFactory.createSessionErrorMessage(UUID(), 'This is my error message', 'This is a longer description of the error message');
const napMessageRetrievedProjects = NAPEventCatalogue.v1.MessageFactory.createProjectsRetrievedMessage(UUID(), ['NAPTestWebShortName1', 'NAPTestWebShortName2', 'NAPTestWebShortName3', 'NAPTestWebShortName4', 'NAPTestWebShortName5', 'NAPTestWebShortName6']);
const napMessagewebAppSelected = NAPEventCatalogue.v1.MessageFactory.createWebAppSelectedMessage(UUID(), 'webAppUrl', 'webAppProducer', new Date(Date.now()), 'webAppShortName', 'webAppServiceEntry', ['1'])

FHIR

...

-Value-getter

Funktioner, som gør det lettere at hente FHIR specifikke værdier ud af en NAPMessage. Disse kan bruges ved at importere namespacet FHIRValueGetter.

Eksempel på anvendelse

...

af FHIR-value-

...

setter

Følgende eksempel mapper en NAPMessage til en SAMLassertion og PatientInfo.

import { FHIRValueGetter, NAPMessage, NAPPatientInfo } from 'nap-typescript-sdk';
const sessionTokenpatientData: NAPPatientInfo = FHIRValueGetter.getSessionValue(napMessage);
const patientData: NAPPatientInfo = FHIRValueGetter.getSessionValue(napMessage);

filterEvent

Funktion, som gør det lettere at sortere i eventstrømmen og dermed subscribe til specifikke event typer

Eksempel på anvendelse af

...

filterEvent

import {filterEvents, NAPEventCatalogue} from 'nap-typescript-sdk';

nap.incoming$.pipe(
        filterEvents([
          NAPEventCatalogue.v1.SessionOpen,filterEvent(
          NAPEventCatalogue.v1.SessionClose,
        ])
      )

Fhir-Value-Setter

Enums som gør det nemmere at lave NAPMessages indholdende de værdier, som overholder FHIR standarden.

Komplet liste over hjælpeværdier.

Eksempel på anvendelse Fhir-Value-Setter (Session Error)

...

Generel kodedokumentation findes i biblioteket. Fuld implementation af eventkataloget ses i nap-reference-web her https://svn.nspop.dk/svnsrc/components/nap/nap-reference-web/trunk/.

...

 Session-

...

close

Følgende eksempel sender / modtager en Session-Open besked og får en SAMLassertion tilbage:Close besked når ønsker, at blive logget ud.

import { NapAngularService } from 'nap-angular-sdk';
import { filterEvents, NAPEventCatalogue, NAPMessage } from 'nap-typescript-sdk';
import { v4 as UUIDNapAngularService } from 'uuidnap-angular-sdk';

exportimport class MyComponent {
	
	// proxy for SAMLAssertion
	public session$: Observable<NAPMessage | undefined> = 
		this.napSDK.incoming$.pipe(
		filterEvents([NAPEventCatalogue.v1.SessionOpen, NAPEventCatalogue.v1.SessionClose])
	);
		//inject the nap-angular-sdk service
	constructor(private napSK: NapAngularService) {
		// Construct an SessionOpen NAPMessage
		const napMsg: NAPMessage = {
			date: new Date().toISOString(),
			id: UUID(),
			event: { type: NAPEventCatalogue.v1.SessionOpen },
		};

		// Ask for the SAMLassertion in host
		this.napSDK.sendMessage(napMsg); filterEvent, NAPEventCatalogue, NAPMessage } from 'nap-typescript-sdk';
import { v4 as UUID } from 'uuid';

export class MyComponent {
	
	innerLogout = new Subject<undefined>();
  
	logOut$: Observable<undefined> = merge(
    this.innerLogout,
    this.napSDK.incoming$.pipe(
      filterEvent(NAPEventCatalogue.v1.SessionClose),
      map(() => undefined)),
  	);
	
	//inject the nap-angular-sdk service
	constructor(private napSK: NapAngularService) {
	}

	/**
   * TrickerHandle logout eventevents
   */
  logout(): void {
    const napMsg: NAPMessage = {
      date: new Date().toISOString(),
      id: UUID(),
      event: { type: NAPEventCatalogue.v1.SessionClose },
    };
    this.napSDK.sendMessage(napMsg);
	this.innerLogout.next(undefined);
  }
	

}

Patient-Open og Patient-close

...

Nap-react-sdk udstiller en komponent kaldet NAPContextProvider. Denne komponent sørger for at kalde createNAP() fra nap-typescript-sdket og dermed initialisere kontekstbroen i React.UseEffect(), som kaldes efter render() kaldes første gang.

Samtiditig subscribes der på de forskellige messagestreams, og deres emits håndteres i React.state på Contextprovideren.

De forskellige subscriptions og håndtag håndteres i react.useCallback. De forskellige states og methodemetode-håndtag pakkes alt sammen i en Context.

...

Denne kontekst kan blive injectet i child elementer ved kalde `createNAP()`. Hvis denne funktion kaldes udenfor en NapContext kaster det kastes en fejl.

Effekten for anvenderen bliver, at broen initialiseres som en singleton, og at beskeder sendt over broen opdatere context state af applikationen, og på den baggrund vil React kalder Render().

Eksempel på anvendelse af nap-react-sdk

...

SessionClose og latestError

Følgende eksempel viser hvordan man kan anvende nap-react-sdk til at vise og sende beskeder:

import { NapContextProvider, NAPEventType, useNap } from 'nap-react-sdk';
import React from 'react';
import { v4 as UUID } from 'uuid';

const IncomingMessageComponent: React.FC = () => {
  const napContext = useNap()

  return <div> {JSON.stringify(napContext.latestIncoming)}</div>
}

const IncomingErrorsComponent: React.FC = () => {
  const napContext = useNap()
  return (
    <div >
      <p> Error received: {JSON.stringify(napContext.latestError)}</p>
    </div>
  )
}


const PostMessageComponent: React.FC = () => {
  const napContext = useNap()
  return (
    <button
      onClick={() => {
        napContext.postMessage({
          date: new Date().toString(),
          id: UUID(),
          event: { type: NAPEventType.SessionOpenSessionClose }
        })
      }}
    >
      Send message
    </button>
  )
}

const App = () => {

  return (
    <>
      <NapContextProvider>
        <IncomingMessageComponent></IncomingMessageComponent>
		<IncomingErrorsComponent></IncomingErrorsComponent>
        <PostMessageComponent></PostMessageComponent>
      </NapContextProvider>
    </>
  )
}

export default App

Generel kodedokumentation findes i bilblioteketbiblioteket.