Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Term

Obligatoriskt

Innehåll

Syfte

samplingId

Ja

Id för provtagningstillfället. Unikt inom det system som skickar uppgifterna.

Sträng av minst ett, max 50 tecken från ASCII 33-126

Nyckel för att senare uppdatera eller radera informationen.

person.personIdTypereferralId

Ja

Typ av identifierare för provgivare.

Någon av:
- RSV704
- RSV707
- OTHER

“OTHER“ används för reservnummerNej

String som identifierar den remiss som föranlett provtagningen.

person.personId.id

Ja

Identifierare för provgivaren. Format bestäms av person.personIdTypeNotera att för personnummer och samordningsnummer används inte skatteverkets officiella definition. Se personidentifierare nedan.
För reservnummer gäller att det skall vara en sträng om som mest 20 tecken och som består av bokstäver, siffror eller tecknen - eller +

person.personId.type

Ja

OID för typ av identifierare för provgivare.

Tjänsten accepterar följande typer:

  • 1.2.752.129.2.1.3.1 (Personnummer)

  • 1.2.752.129.2.1.3.3 (Samordningsnummer)

  • OTHER (Reservnummer)

person.sex

Ja

Provgivarens biologiska kön. Någon av:
- MALE
- FEMALE

opposeTo

Ja

Samtyckesinformation. Lista av noll eller flera av:
- CARE_AND_TREATMENT
- EDUCATION_DEVELOPMENT_QUALITY
- RESEARCH
- PRODUCT

Om provgivaren inte har någon registrerad begränsning skickas en tom lista, alltså att provgivaren inte motsatt sig något syfte.

Anger användning som provgivaren motsätter sig.

Om samtliga är angivna betraktas detta som att provet inte ska sparas och information om provet raderas i SBR

samplingOriginsampleLocation.organisationNamesampleCollection

Ja

Sträng som identifierar den huvudman i vilkens regi proverna sparas

Exempel: “Region Uppsala”

Används för att identifiera rätt provsamling

samplingOrigin.departmentName

Ja

Sträng som identifierar den avdelning i vilkens regi proverna sparas

Exempel: “Patologi/Cytologi”

samplingOrigin.sampleCollection

Ja

Sträng som identifierar specifik provsamling där proverna sparas. Är ofta samma som departmentName då en avdelning ofta bara har en provsamling, men kan vara olika då flera provsamlingar kan hanteras på samma enhet (labb).

Exempel “Patologi/Cytologi”specifik provsamling där prov sparas. Producenten håller information om vilken provförvaringsenhet och vilken huvudman provsamlingen tillhör.

Exempel “Region X Patologi/Cytologi”

samplingDate

Nej

Datum då prov togs. Får ej vara j framtiden.

Denna är tänkt att ersätta registrationDate när alla LIS-system kan skicka den.

registrationDate

Ja

Det datum då prov registrerades i LIS. Får ej vara i framtiden.
ISO-8601 (se nedan)

samplingLocation.principal

Nej

HSA-id som identifierar huvudman för den vårdenhet där prov togs.

samplingLocation.principal.root

Ja

OID för HSA-Id; 1.2.752.129.2.1.4.1

Obligatoriska om principal anges

samplingLocation.principal.extension

Ja

Unikt HSA-id för huvudman.

samplingLocation.careFacility

Nej

HSA-id som identifierar den vårdenhet där prov togs.

samplingLocation.careFacility.root

Ja

OID för HSA-Id; 1.2.752.129.2.1.4.1

Obligatoriska om careFacility anges

samplingLocation.careFacility.extension

Ja

Unikt HSA-id för vårdenhet.

sampleOrigin

Nej

Om prov har skickats mellan labb kan sampleOrigin användas för att ange senast föregående förvaringsplats.

sampleOrigin.principal

Nej

HSA-id som identifierar huvudman för den enhet där prov tidigare förvarades

sampleOrigin.principal.root

Ja

OID för HSA-Id; 1.2.752.129.2.1.4.1

sampleOrigin.principal.extension

Ja

Unikt HSA-id för huvudman.

sampleOrigin.department

Nej

HSA-id som identifierar den enhet där prov tidigare förvarades

sampleOrigin.department.root

Ja

OID för HSA-Id; 1.2.752.129.2.1.4.1

sampleOrigin.department.extension

Ja

Unikt HSA-id för huvudman

samples

Lista av prover tagna vid provtagningstillfället. Noll eller flera.
Om en tom lista av prover skickas raderas provtagningstillfället.

samples[].identifier

Ja

Identifierare för prov. Unikt per provsamling

Sträng av minst ett, max 50 tecken från ASCII 33-126

samples[].label

Nej

Sträng som används för att personalen ska kunna hitta provet, alltså samma som det fysiska provet är märkt med.

Sträng av minst ett, max 50 tecken från ASCII 33-126

samples[].registrationDate

Ja

Det datum då provet registrerades i LIS. Får ej vara i framtiden.
ISO-8601 (se nedan)

samples[].anatomicalPosition

Ja sampleAnatomicalPositions

Ja om histologi eller cytologiprov

Lista av en eller flera positioner från /anatomical_positions (se nedan)

samples[].materialTypesampleMaterialType

Ja

En av typerna från /material_types , se nedan

samples[].samplingDate

Nej

Datum då proverna togs. Får ej vara j framtiden.

Denna är tänkt att ersätta sample.registration_date när alla LIS-system kan skicka den.

Exempel

Code Block
languagejson
{
    "samplingId": "12341234",
    "referralId": "43214321",
    "person": {
        "personId": { 
        "personIdTypeid": "RSV704191212121212",
        "personIdtype":; "191212121212"1.2.752.129.2.1.3.1"
        },
        "sex": "MALE"
    },
    "opposeTo": [
        "RESEARCH"
    ],
    "samplingOriginsampleLocation": {
        "organisationNamesampleCollection": "Region_Uppsala",Labb X Patologi"
    },
    "samplingDate": "2022-04-20",
    "departmentNameregistrationDate": "Patologi",2022-04-25",
    "samplingLocation": {
        "principal": {
          "sampleCollectionroot": "Patologi"1.2.752.129.2.1.4.1",
    },      "samplesextension": [ "SE1234567-89"
        },
        "careFacility": {
          "identifierroot": "12341.2.752.129.2.1.4.1",
          "labelextension": "A778",
SE1234567-88"        },
    },
       "registrationDatesampleOrigin": {
     "2022-04-20",   "principal": {
          "sampleAnatomicalPositionsroot": ["1.2.752.129.2.1.4.1",
          "extension":  "T02SE1234567-98"
        ],},
        "department": {
          "sampleMaterialTyperoot": "Vävnad1.2.752.129.2.1.4.1",
          "samplingDateextension": "2022SE1234567-04-20"87"        },
    },
    "samples": [
        {
        "identifier": "23451234",
        "label": "A779A778",
        "registrationDatesampleAnatomicalPositions": [
     "2022-04-20"       "T02"
        ],
        "sampleAnatomicalPositionssampleMaterialType": [ "Vävnad"
    },
        {
        "identifier": "T032345",
         ]"label": "A779",
        "sampleMaterialTypesampleAnatomicalPositions": [
            "Vävnad"T03"
        ],
        "samplingDatesampleMaterialType": "2022-04-20Vävnad"
    }
    ]
}

Datumformat

För samtliga datum används ISO-8601 utan tidszon, t.ex. 1998-06-22.

...

För att identifiera en provgivare används personnummer (RSV704) , samordningsnummer (RSV707) eller reservnummer.
Personer som inte kan identifieras med någon av dessa identifierare exkuderas ur integrationen. Notera att detta även gäller barn som saknar personnummer, de ska inte registreras på mammans personnumer utan exkluderas tills dess att de fått personnummer.

...

Lista av giltiga materialtyper finns på /material_types. Endast typer definerade här får användas, andra strängar ger felmeddelande.
Ett prov kan endast ha en materialtyp. De är definerade hierarkiskt så att t.ex. serum, plasma och helblod är underordnade blod.

Avsändare

För att korrekt hantera provtagningen behöver vi kunna identifiera avsändaren.
Identiteten skickas som en sträng i klartext, som mappas mot en intern identifierare i SBR, och måste därmed vara konstant över tid.
Identiteten överenskommes i förväg mellan sändande och mottagande part så att SBR kan konfigureras korrekt från start.
Notera att system inte är med då detta hämtas ur certifikatet (HSA-ID).

Url:er och endpoints

Demo-/testmiljö: https://samples.sbr.demo.biobanksverige.se/integration/sample/v1

...