Versions Compared

Old Version 19

changes.mady.by.user Unknown User (nha@kmd.dk)

Saved on

compared with

New Version 20

changes.mady.by.user Unknown User (tbr@kvalitetsit.dk)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 17 - [SDS-5457] btr 2018-snitflade genintroduceret

...

Version

Dato

Ændring

Ansvarlig

1.0.1

2018-08-09

Initialt dokument

Trifork

-2018-08-10Tilføjelser til snitfladebeskrivelseTrifork
1.0.22018-08-31Ny releaseTrifork
1.0.32018-09-06Endpoints ændret fra /ltr-btr til /btrTrifork
1.0.62018-10-15

Tilføjet data-elementet noForcedTreatmentIfIncapable

Fjernet elementet relativeAcceptanceRequired og indført acceptanceNeeded for alle 4 Behandlingstestamente-spørgsmål

Opdateret request/response XML-eksempler

Trifork
1.1.02020-03-24TreatmentWillV2 med noLifeProlongingIfDying uden angivelse af yderligere acceptKvalitetsIT
1.1.12020-03-30TreatmentWill validerer ingen yderligere accept angives på noLifeProlongingIfDyingKvalitetsIT
1.1.22021-10-12Opdateret ifm. udfasning af btr-snitflade med accept fra pårørende, værge eller fremtidsfuldmægtig for uafvendeligt døendeKvalitetsIT

HL7 CDA

Modellen der anvendes til at repræsentere livs- og behandlingstestamentedata er HL7 CDA (se evt. http://www.hl7.org/implement/standards/product_brief.cfm?product_id=7 ), som er en XML-baseret standard til repræsentation af kliniske data. HL7 CDA er et begrebsapparat, som kan repræsentere en enorm mængde af forskelligartede data, hvoraf kun en lille delmængde anvendes i servicen. Det anbefales derfor at studere eksemplerne der refereres her på siden frem for modellen der defineres af HL7 CDA, da de giver et mere præcist billede af hvilke data der kræves og returneres af de forskellige operationer. CDA-terminologien gør, at man kan kvalificere de forskellige begreber gennem attributter (f.eks. at et id er et CPR nummer ved at angive assigningAuthorityName="CPR"), og derfor valideres der i servicen, at disse attributter anvendes korrekt, så der ikke er tvivl om hvordan data skal fortolkes. Dvs. i praksis sker der en strengere validering end WSDL og XSDer dikterer.

...

v2btrV2 v2btrV2
WSDL-filer
HTML-side med overblik
<server>/btr/wsdl
Livstestamenteregister DGWS
<server>/btr/wsdl/ltr/dgws
Livstestamenteregister IDWS
<server>/btr/wsdl/ltr/idws

Behandlingstestamenteregister DGWS

<server>/btr/wsdl/
btr/dgws
Behandlingstestamenteregister IDWS
<server>/btr/wsdl/
btr/idws

WSDL Livstestamenteregistret

Behandlingstestamenteregister DGWS v2<server>/btr/wsdl/btrV2/dgws
Behandlingstestamenteregister IDWS v2<server>/btr/wsdl/btrV2/idws


WSDL Livstestamenteregistret

Operation

Beskrivelse

DGWSIDWS

Operation

Beskrivelse

DGWSIDWS

CreateLivingWillRequest_2018_05_01

Opret en livstestamenteregistrering for en specifik borger

NejJa

UpdateLivingWillRequest_2018_05_01

Opdatér en borgers livstestamenteregistrering

NejJa

DeleteLivingWillRequest_2018_05_01

Slet en borgers livstestamenteregistrering

NejJa

GetLivingWillRequest_2018_05_01

Hent en livstestamenteregistrering for en specifik borger

JaJa

HasLivingWillRequest_2018_05_01

Hent om en specifik borger har en livstestamenteregistrering

JaJa

WSDL Behandlingstestamenteregistret

...

Operation

Beskrivelse

DGWSIDWS

CreateTreatmentWill_20202018_0305_1601

Opret en behandlingstestamenteregistrering for en specifik borger

NejJa

UpdateTreatmentWill_20202018_0305_1601

Opdatér en borgers behandlingstestamenteregistrering

NejJa

DeleteTreatmentWill_20202018_0305_1601

Slet en borgers behandlingstestamenteregistrering

NejJa

GetTreatmentWill_20202018_0305_1601

Hent en behandlingstestamenteregistrering for en specifik borger

JaJa

HasTreatmentWill_20202018_0305_1601

Hent om en specifik borger har en behandlingstestamenteregistrering

JaJa

Serviceoperationer Livstestamenteregistret

WSDL Behandlingstestamenteregistret version 2

Operation

Beskrivelse

DGWSIDWS

CreateTreatmentWill_2020_03_16

Opret en behandlingstestamenteregistrering for en specifik borger

NejJa

UpdateTreatmentWill_2020_03_16

Opdatér en borgers behandlingstestamenteregistrering

NejJa

DeleteTreatmentWill_2020_03_16

Slet en borgers behandlingstestamenteregistrering

NejJa

GetTreatmentWill_2020_03_16

Hent en behandlingstestamenteregistrering for en specifik borger

JaJa

HasTreatmentWill_2020_03_16

Hent om en specifik borger har en behandlingstestamenteregistrering

JaJa

Serviceoperationer Livstestamenteregistret

Nedenfor beskrives de forskellige operationer i servicen. For hver operation gives eksempler på request/response hvis aktuelle (for simpelhedens skyld uden DGWS/IDWS headers). Eksemplerne tjener dels til formål Nedenfor beskrives de forskellige operationer i servicen. For hver operation gives eksempler på request/response hvis aktuelle (for simpelhedens skyld uden DGWS/IDWS headers). Eksemplerne tjener dels til formål at give overblik over hvad der skal til for at bruge en operation, men demonstrerer samtidigt hvilke attributter der er krævet. Dvs. de forskellige requests angiver hvad der som minimum skal angives.

...

Element

Beskrivelse

Type

willExists

Eksisterer der en livstestamenteregistrering for den pågældende person der laves en forespørgsel for.

hl7:bl

Serviceoperationer Behandlingstestamenteregistret

person der laves en forespørgsel for.

hl7:bl

Serviceoperationer Behandlingstestamenteregistret

I det følgende foreståes følgende, når der angives treatmentWill som element: For oprindelig version anvendes treatmentWill, for version 2 af servicen anvendes treatmentWillV2.

Der er request og response eksempler for både oprindelig version og version 2.

CreateTreatmentWill

Request-eksempel: CreateTreatmentWillRequest.xml *1

Request-eksempel v2: CreateTreatmentWillRequest_v2.xml

Nej

Element

Beskrivelse

Type

Optionel

id

Som attribut "extension" angives personens CPR-nummer (uden bindestreg)

varchar(30)

Nej

treatmentWillV2treatmentWill


Data for en behandlingstestamenteregistrering. Type er TreatmentWillV2 TreatmentWill. Se tabel under afsnittet Typer.

-

Nej

-

Response-eksempel (indeholder ingen data): CreateTreatmentWillResponse.xml 

Response-eksempel v2 (indeholder ingen data): CreateTreatmentWillResponse_v2.xml

UpdateTreatmentWill

Request-eksempel: UpdateTreatmentWillRequest.xml *1

Request-eksempel v2: UpdateTreatmentWillRequest_v2.xml

Element

Beskrivelse

Type

Optionel

id

Som attribut "extension" angives personens CPR-nummer (uden bindestreg)

varchar(30)

Nej

treatmentWillV2treatmentWill

Data for en behandlingstestamenteregistrering. Type er TreatmentWillV2 TreatmentWill. Se tabel under afsnittet Typer.

-

Nej

Response-eksempel (indeholder ingen data): UpdateTreatmentWillResponse.xml

Response-eksempel v2 (indeholder ingen data): UpdateTreatmentWillResponse_v2.xml

DeleteTreatmentWill

Request-eksempel: DeleteTreatmentWillRequest.xml

Request-eksempel v2: DeleteTreatmentWillRequest_v2.xml

Element

Beskrivelse

Type

Optionel

id

Som attribut "extension" angives personens CPR-nummer (uden bindestreg)

varchar(30)Nej)

Nej

Response-eksempel (indeholder ingen data): DeleteTreatmentWillResponse.xml

Response-eksempel v2 (indeholder ingen data): DeleteTreatmentWillResponse_v2.xml

GetTreatmentWill

Request-eksempel: GetTreatmentWillRequest.xml

Request-eksempel v2: GetTreatmentWillRequest_v2.xml

...

Response-eksempel: GetTreatmentWillResponse.xml

Response-eksempel: GetTreatmentWillResponse_v2.xmlxml

Element

Beskrivelse

Type

realmCode

Krævet pr. standard, fast værdi


typeId

Krævet pr. standard, fast værdi


templateId

Krævet pr. standard, fast værdi


id

Krævet pr. standard, fast værdi


code

Element

Beskrivelse

Type

realmCode

Krævet pr. standard, fast værdi


typeIdtitle

Krævet pr. standard, fast værdi


templateIdeffectiveTime

Krævet pr. standard, fast værdi


idConfidentialityCode

Krævet pr. standard, fast værdi


codelanguageCode

Krævet pr. standard, fast værdi

title

Krævet pr. standard, fast værdi

effectiveTime


versionNumber

Versionsnummer for en registrering


recordTarget.patient Role.id

Borgerens CPR-nr i "extension"-attribut


author.time

Dato/tid. Format: yyyyMMddHHmmssZ, fx. 20171024143445+0200


author.assignedAuthor.id

Borgerens CPR-nr i "extension"-attribut


Nedenstående elementer hører alle under component.structuredBody.component.section.entry.observation

code

Krævet pr. standard, fast værdi

ConfidentialityCode

Krævet pr. standard, fast værdi

languageCode

Krævet pr. standard, fast værdi


versionNumbervalue

Versionsnummer Data for en registreringbehandlingstestamenteregistrering

recordTarget.patient Role.id

Borgerens CPR-nr i "extension"-attribut

author.time

Dato/tid. Format: yyyyMMddHHmmssZ, fx. 20171024143445+0200

author.assignedAuthor.id

Borgerens CPR-nr i "extension"-attribut

Nedenstående elementer hører alle under component.structuredBody.component.section.entry.observation

code

Krævet pr. standard, fast værdi

value

Data for en behandlingstestamenteregistrering

TreatmentWill. Se tabel under afsnittet Typer.

HasTreatmentWill

TreatmentWill. Se tabel under afsnittet Typer.

HasTreatmentWill

Request-eksempel: HasTreatmentWillRequest.xml

Request-eksempel: HasTreatmentWillRequest_v2.xml

Element

Beskrivelse

Type

Optionel

id

Som attribut "extension" angives personens CPR-nummer (uden bindestreg)

varchar(30)

Nej

Response: HasTreatmentWillResponse.xml

Response: HasTreatmentWillResponse_v2.xml

Element

Beskrivelse

Type

willExists

Eksisterer der en behandlingstestamenteregistrering for den pågældende person der laves en forespørgsel for.

hl7:bl

Typer

LivingWill

Den generelle struktur der anvendes på create- og update-requests, samt på get-responses, ser ud som følger:Request-eksempel: HasTreatmentWillRequest_v2.xml

Element

Beskrivelse

Type

Optionel

id

Som attribut "extension" angives personens CPR-nummer (uden bindestreg)

varchar(30)

Nej

Response: HasTreatmentWillResponse_v2.xml

...

Element

...

Beskrivelse

...

willExists

...

Eksisterer der en behandlingstestamenteregistrering for den pågældende person der laves en forespørgsel for.

...

noLifeProlongingIfDying

Livstestamente tilkendegivelse

Boolean

Nej

noLifeProlongingIfSeverelyDegraded

Livstestamente tilkendegivelse

Boolean

Nej

TreatmentWill

Typer

...

Den generelle struktur der anvendes på create- og update-requests, samt på get-responses, ser ud som følger:

BooleannoLifeProlongingIfSeverelyDegradedLivstestamente Boolean

Element

Beskrivelse

Type

Optionel

noLifeProlongingIfDying

Livstestamente tilkendegivelse

Optionel

noLifeProlongingIfDying

Behandlingstestamente tilkendegivelse

TreatmentWillValueType*1

Nej

noLifeProlongingIfSeverelyDegraded

Behandlingstestamente tilkendegivelse

TreatmentWillValueType

Nej

noLifeProlongingIfSeverePainBehandlingstestamente tilkendegivelseTreatmentWillValueTypeNej
noForcedTreatmentIfIncapableBehandlingstestamente tilkendegivelseTreatmentWillValueTypeNej

TreatmentWillV2

Den generelle struktur der anvendes på create- og update-requests, samt på get-responses, ser ud som følger:

Element

Beskrivelse

Type

Optionel

noLifeProlongingIfDying

Behandlingstestamente tilkendegivelse

TreatmentWillValueTypeWithoutAcceptanceNeeded

Nej

noLifeProlongingIfSeverelyDegraded

Behandlingstestamente tilkendegivelse

TreatmentWillValueTypeWithAcceptanceNeeded

Nej

noLifeProlongingIfSeverePainBehandlingstestamente tilkendegivelseTreatmentWillValueTypeWithAcceptanceNeededNej
noForcedTreatmentIfIncapableBehandlingstestamente tilkendegivelseTreatmentWillValueTypeWithAcceptanceNeededNej

TreatmentWillValueType/TreatmentWillValueTypeWithAcceptanceNeeded

Elementets er en standard boolean, hvis indhold kan være "true" eller "false".

...

Hvis denne attribut udelades, angiver dette, at der ikke er angivet nogen værdi for denne data. Bemærk, at attributten kun må angives såfremt elementets indhold er "true"; denne validering foregår i servicen og kan ikke ses ud fra XML Schema'et.

*1: det er fra version 1.1.1 ikke længer tilladt at angive acceptanceNeeded for noLifeProlongingIfDying i den oprindelige snitflade (TreatmentWill). Der vil blive returneret med en soap fejl, hvis det sker. 

TreatmentWillValueTypeWithoutAcceptanceNeeded

...