Wiki
Clone wikibest-practice / Arbetsdokument - ny version av De facto-konventioner för datatyper
Version | Datum | Ändringar | Person |
---|---|---|---|
1 | 2013-10-22 | - | Björn Genfors |
2 | 2013-12-16 | Justerat beskrivningen av HSAIdType och orgUnitHSAId (enligt issue 221) | Björn Genfors |
3 | 2014-02-17 | Justerat schema-innehåll | Khaled Daham |
4 | 2014-03-21 | -Lagt till ResultType, som används för att hantera logiska fel. -Lagt till !RoleCode 0..1 i LegalAuthenticatorType (behov fanns i kontrakten för bild och EKG). -Lagt till länkar till lista över vanligt förekommande kodverk och identifierare på lämpliga ställen. |
Björn Genfors |
5 | 2014-05-13 | -Lagt till PQIntervalType. -Justerat DateType att tillåta variabel noggrannhet. -Förtydligat beskrivningen av vissa typer och/eller fält. |
Björn Genfors |
6 | 2014-08-21 | Uppdaterad beskrivning för DateType och TimeStampType. | Khaled Daham |
7 | 2014-09-10 | -Korrigerat dokumentation för DateType för att revertera möjligheten till variabel noggrannhet (kompatibilitetsbekymmer med ISO-standarder) -Lagt till en ny typ, PartialDateType, för att bära information om datum med variabel noggrannhet. |
Björn Genfors |
8 | 2015-09-09 | -Korrigerat ActorType.name till ActorType.personName. | Björn Genfors |
9 | 2016-06-28 | Uppdaterat ActorType och OrgUnitType till ny typ framtagen inom arbetet för JoL | Thomas Siltberg |
10 | 2016-09-15 | Tog bort ResultType för att få konsistens med regelverk och andra anvisningar | Tommy Carlsson |
11 | 2016-11-16 | Lade tillbaka ResultType med struktur överensstämmande med regelverk och andra anvisningar | Tommy Carlsson |
12 | 2017-02-15 | Förtydligat att elementen för att returnera logiska fel inte ska definieras som egen typ. Elementen ska inkluderas i svarstypen. | Tommy Carlsson |
13 | 2020-01-30 | Skapat utkast för kommande ändringar | Claudia Ehrentraut |
14 | 2020-04-06 | Korrigering av datatyperna PQType och PQInterval | Torbjörn Dahlin |
Här dokumenteras informella best-practices för datatypshantering i tjänstekontrakt
Denna sida syftar till att öka återanvän dningen av datatyper, och i förlängningen verka för återanvändbara profiler.
##Gemensamma informationskomponenter
I tjänstekontraktsbeskrivningarna används ett antal komponenter som är gemensamma för vissa meddelanden i flera domäner eller inom denna domän, och dessa beskrivs i detta avsnitt.
Observera att med anledning av att tjänstekontrakten även kan stödjas av producentsystem som saknar (fullständig) HSA-id-information så är HSA-id-attribut i beskrivningarna nedan valfria. Se även avsnittet ”Informationssäkerhet” ovan.
##Index
###ActorType
Information om medarbetare i vård- och omsorg som genomfört den behandling som rapporteras genom tjänstekontrakt i denna domän.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
hsaId | HSAIdType | HSA-id för personen | 0..1 |
personName | string | Namn på personen. Minst ett av dessa fälten hsaId och name ska anges. | 0..1 |
personTelecom | string | Telefon till personen. | 0..1 |
personEmail | string | Epostadress till personen. | 0..1 |
personAddress | string | Postadress till personen. | 0..1 |
CVType
Typ som beskriver kodade värden med en struktur hämtad från HL7 v3 CV ("CodedValue"). Kodade värden avser officiellt hanterade kodverk som hänvisas till med codeSystem OID/UUID Vanligt förekommande kodverk.
För annan användning av koder, exempelvis för lokala kodverk utan OID, skall originalText attributet användas för att ge kodens text i det lokala systemet, och övriga attribut lämnas tomma.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
code | string | Kod enligt producentsystemets kodverk. Om code anges skall också codeSystem samt displayName anges. | 0..1 |
codeSystem | string | Anger kodverket som definierar koden. Dvs UID/OID för det kodverk som används. Om codeSystem anges skall också code samt displayName anges. | 0..1 |
codeSystemName | string | Kodverkets namn i klartext. Skall anges när så är möjligt. | 0..1 |
codeSystemVersion | string | Om tillämpbart, versionsangivelse som definierats av det givna kodsystemet. | 0..1 |
displayName | string | Koden i klartext, under vilket det producerande systemet visar koden för sina användare. Om separat displayName inte finns i producerande system skall det ange samma värde som för code. | 0..1 |
originalText | string | originalText ska användas vid överföring av värden som kommer från lokala kodverk som ej är identifierade med OID eller när kod helt saknas. I sådana fall skall en beskrivande text anges i originalText. Om originalText anges kan ingen av de övriga elementen anges. | 0..1 |
###DatePeriodType
Ett datumintervall anges normalt sett med ett start- och ett slutdatum, men öppna intervall är tillåtna. Huruvida ändpunkterna inkluderas i intervallet eller ej bör tydligt beskrivas vid varje enskild tillämpning.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
start | DateType | Periodens startdatum. Minst ett av start och end skall anges. | 0..1 |
end | DateType | Periodens slutdatum. Minst ett av start och end skall anges. | 0..1 |
###DateType
Datum anges på formatet ”ÅÅÅÅMMDD”. Detta motsvarar den ISO 8601 och ISO 8824-kompatibla formatbeskrivningen ”YYYYMMDD”. Tidszon anges inte i meddelandeformaten. All information om datum och tidpunkter som utbyts via tjänsterna ska ange datum och tidpunkter i den tidszon som gäller/gällde i Sverige vid den tidpunkt som respektive datum- eller tidpunktsfält bär information om. Såväl tjänstekonsumenter som tjänsteproducenter skall med andra ord förutsätta att datum och tidpunkter som utbyts är i tidszonerna CET (svensk normaltid) respektive CEST (svensk normaltid med justering för sommartid).
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
date | string | Datum uttrycks på formatet ”ÅÅÅÅMMDD”. | 1..1 |
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
authorTime | TimeStampType | Den tidpunkt då dokumentet skapades, eller annan tillämplig tidpunkt. | 1..1 |
healthcareProfessionalHSAId | HSAIdType | HSA-id för vård- och omsorgspersonal. Skall anges om tillgänglig. | 0..1 |
healthcareProfessionalName | string | Namn på vård- och omsorgspersonal. Om tillgängligt skall detta anges. | 0..1 |
healthcareProfessionalRoleCode | CVType | Information om personens befattning. Om möjligt skall KV Befattning användas. | 0..1 |
healthCareProfessionalOrgUnit | OrgUnitType | Den organisation som angiven vård- och omsorgsperson är uppdragstagare på. Om tillgängligt skall detta anges. | 0..1 |
healthcareProfessionalCareUnitHSAId | HSAIdType | HSA-id för PDL-enhet som vård- och omsorgspersonen är uppdragstagare för. Skall anges om tillgänglig. | 0..1 |
healthcareProfessionalCareGiverHSAId | HSAIdType | HSA-id för vårdgivaren, som är vårdgivare för den enhet som författaren är uppdragstagare för. Skall anges om tillgänglig. | 0..1 |
###HSAIdType###
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
hsaId | string | HSA-id enligt definition från Inera AB. I de fall då HSA-id inte finns tillgängligt ska ett för källsystemet lokalt id användas. Lokala id:n får enbart användas i OrgUnitType, och då endast i undantagsfall. | 1..1 |
###IIType En universellt unik identifierare.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
root | string | En universellt unik identifierare eller en identifierare som tillsammans med värdet för ”extention” ger en universellt unik identifierare. | 1..1 |
extension | string | En textsträng som tillsammans med värdet för "root" bildar en unik identifierare. Används om värdet på "root" inte är universellt unikt. | 0..1 |
###LegalAuthenticatorType Används för att representera en signatur i samband med journalhandlingar.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
signatureTime | TimeStampType | Tidpunkt för signering | 1..1 |
legalAuthenticatorHSAId | HSAIdType | HSA-id för person som signerat dokumentet | 0..1 |
legalAuthenticatorName | string | Namnen i klartext för signerande person | 0..1 |
legalAuthenticatorRoleCode | CVType | Information om personens befattning. Om möjligt skall KV Befattning användas. | 0..1 |
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
id | string | Identitet på multimediaobjekt som används vid referenser inom multimediadokument. | 0..1 |
mediaType | MediaTypeEnum | Mediatyper enligt HL7 | 1..1 |
value | base64Binary | Value är binärdata som representerar objektet. Ett och endast ett av value och reference ska anges. | 0..1 |
reference | anyURI | Referens till extern bild i form av en URL. Ett och endast ett av value och reference ska anges. | 0..1 |
###OrgUnitType
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
orgUnitHSAId | HSAIdType | HSA-id för organisationsenhet. Om tillgängligt skall detta anges. I de fall HSA-id saknas kan ett för källsystemet unikt id användas. | 0..1 |
orgUnitName | string | Namn på organisationsenhet. Om tillgängligt skall detta anges. | 0..1 |
orgUnitTelecom | string | Telefon till organisationsenhet. | 0..1 |
orgUnitEmail | string | Epost till organisationsenhet. | 0..1 |
orgUnitAddress | string | Postadress till organisationsenhet. Skrivs på ett så naturligt sätt som möjligt, exempelvis: ”Storgatan 12 468 91 Lilleby” |
0..1 |
orgUnitLocation | string | Text som anger namnet på plats eller ort för enhetens eller funktionens fysiska placering | 0..1 |
Kan beskriva ett datum med variabel noggrannhet.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
format | DateTypeFormatEnum | Enum som beskriver datumets noggrannhet. Tillåtna värden är "YYYYMMDD", "YYYYMM" och "YYYY". | 1..1 |
value | string | Sträng som håller själva datumet, och uttrycks på det format som anges i format. | 1..1 |
Innehåller basinformation om ett dokument. Används för tjänstekontrakt som tillverkas enligt HL7-metoden "Green CDA".
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
documentId | string | Dokumentets identitet som är unik inom källsystemet. | 1..1 |
sourceSystemHSAId | HSAIdType | HSAid för det system som dokumentet är skapat i. | 1..1 |
documentTitle | string | Titel som beskriver den information som sänds i dokumentet. | 0..1 |
documentTime | TimeStampType | Händelsetidpunkt, om relevant. | 0..1 |
patientId | PersonIdType | Id för patienten. | 1..1 |
accountableHealthcareProfessional | HealthcareProfessionalType | Ansvarig hälso- och sjukvårdsperson. | 1..1 |
legalAuthenticator | LegalAuthenticatorType | Information om vem som signerat informationen i dokumentet. | 0..1 |
approvedForPatient | boolean | Anger om information får delas till patient. Värdet sätts i sådant fall till true, i annat fall till false. | 1..1 |
careContactId | string | Identitet för den vård- och omsorgskontakt som föranlett den information som omfattas av dokumentet. Identiteten är unik inom källsystemet | 0..1 |
nullified | boolean | Anger om dokumentet makulerats i källsystemet. Sätts i så fall till true annars false. Används bl.a. i statistik-/rapportuttag med hjälp av tjänstekontrakten. | 0..1 |
nullifiedReason | string | Anger orsak till makulering. | 0..1 |
###PersonIdType
Person-id är vanligtvis ett personnummer, men kan även vara samordningsnummer eller reservnummer. Syftar till att identifiera en privatperson.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
id | string | Identiteten enligt den identitetstyp (type) som angivits. Om identiteten är av typ personnummer eller samordningsnummer skall denna anges med 12 tecken utan skiljetecken. | 1..1 |
type | string | OID för typ av identifierare. | 1..1 |
###PQIntervalType
Typ som baseras på datatypen IVL_PQ enligt HL7, och som beskriver överföring av intervaller av mätbara värden (”Physical Quantity”). Ett intervall som är öppet i ena änden kan anges.
Tillåtna värden för ”unit” bestäms av http://unitsofmeasure.org/ucum.html. Dimension ska preciseras av fältregel vid tillämpning (ex. ”Massa”). Vaksamhet skall iakttagas vid konvertering mellan enheter.
Notera att den specialiserade datatypen decimal-primitive används istället för xmltyperna double/decimal. Decimal-primitive behåller signifikanta avslutande 0:or, till skillnad från de föregående. Denna lösning är tagen från HL7 FHIR Release 4 specifikationen avsnitt 2.6.1.2 Code Generation Schema.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
low | decimal-primitive | Mätetal mätt i enheten som anges av ”unit”. Minst ett av fälten low och high måste anges. | 0..1 |
high | decimal-primitive | Mätetal mätt i enheten som anges av ”unit”. Minst ett av fälten low och high måste anges. | 0..1 |
unit | string | Enhet enligt [http://unitsofmeasure.org/ucum.html UCUM] | 1..1 |
###PQType Typ som baseras på datatypen PQ enligt HL7, och som beskriver överföring av mätbara värden (”Physical Quantity”). Tillåtna värden för ”unit” bestäms av http://unitsofmeasure.org/ucum.html. Dimension ska preciseras av fältregel vid tillämpning (ex. ”Massa”). Vaksamhet skall iakttagas vid konvertering mellan enheter.
Notera att den specialiserade datatypen decimal-primitive används istället för xmltyperna double/decimal. Decimal-primitive behåller signifikanta avslutande 0:or, till skillnad från de föregående. Denna lösning är tagen från HL7 FHIR Release 4 specifikationen avsnitt 2.6.1.2 Code Generation Schema.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
value | decimal-primitive | Mätetal mätt i enheten som anges av ”unit”. | 1..1 |
unit | string | Enhet enligt [http://unitsofmeasure.org/ucum.html UCUM] | 1..1 |
###ResultType
Element för att returnera logiska fel i uppdaterande tjänster. Ska inte definieras som egen typ utan inkluderas i svarstypen.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
resultCode | ResultCodeEnum | Kan endast vara OK, INFO eller ERROR. | 1..1 |
resultText | string | En beskrivande text som kan visas för användaren. | 0..1 |
Ett tidsintervall anges normalt sett med en start- och en sluttidpunkt, men öppna intervall är tillåtna. Huruvida ändpunkterna inkluderas i intervallet eller ej bör tydligt beskrivas vid varje enskild tillämpning.
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
start | TimeStampType | Periodens starttid. Minst ett av start och end skall anges. | 0..1 |
end | TimeStampType | Periodens sluttid. Minst ett av start och end skall anges. | 0..1 |
Tidpunkter anges alltid på formatet ”ÅÅÅÅMMDDttmmss”, vilket motsvarar den ISO 8601 och ISO 8824-kompatibla formatbeskrivningen ”YYYYMMDDhhmmss”. Tidszon anges inte i meddelandeformaten. All information om datum och tidpunkter som utbyts via tjänsterna ska ange datum och tidpunkter i den tidszon som gäller/gällde i Sverige vid den tidpunkt som respektive datum- eller tidpunktsfält bär information om. Såväl tjänstekonsumenter som tjänsteproducenter skall med andra ord förutsätta att datum och tidpunkter som utbyts är i tidszonerna CET (svensk normaltid) respektive CEST (svensk normaltid med justering för sommartid).
Namn | Datatyp | Beskrivning | Kardinalitet |
---|---|---|---|
timestamp | string | Tid uttrycks på formatet ”ÅÅÅÅMMDDttmmss”. | 1..1 |
Updated