VGR Fireplace

Profile

Namn på profil

namn
Skrivs enligt mall <VGR om regional><Tillämpning><förkortat profilnamn om mer än två ord>
Exempel: VGRBaseEncounter, VGROncologyQR

titel
Skrivs enligt mall <VGR om regional><Tillämpning><profilnamn>
Exempel: VGR Base Encounter, VGR Oncology QuestionnaireResponse

Declaration

  • Profile: <profilens namn>

Keywords

  • Id: <profilens namn>
  • Description: “<Beskrivning av profilens användningsområde, max 200 tecken>”
  • Title: “<profilens titel>“
  • Parent: <den resurs i FHIR-standard eller basprofiler som denna profil specialiserar>

Caret Paths

Följande egenskaper påverkar den maskinläsbara resurs som genereras (StructureDefinition) och ska alltid anges:

  • ^status = #draft / #active
  • ^experimental = false

Element rules

Efterföljande regler grupperas per element och skrivs i samma ordning som elementen de rör kommer i resursen som profileras.

För varje element, ange regler i följande ordning:

  1. Must support (se även Must support)
  2. Definition (se även Egenskaper på Element)
  3. Comment (se även Egenskaper på Element)
  4. Övriga regler och restriktioner

Gör en tom rad mellan varje grupp med regler. Lägg eventuella inline extensions sist i filen.
Mer information finns på HL7 FHIR Element Definition

Must support

Element som innehåller information som det det aktuella systemet måste kunna hantera då resursen används markeras som Must Support (MS). Notera att detta inte innebär att informationen måste finnas i varje enskilt fall. Ett anrop kan ge ett NULL-värde för detta element. Detta skiljer MS från kardinalitet 1..* där information måste finnas. Se även HL7 FHIR MustSupport

Basprofiler

Basprofiler ska följa principen Löst begränsad och därmed undviks MS i basprofiler. Användning SKALL motiveras och beskrivas tydligt då denna MS behöver efterlevas av alla tillämpningar i regionen.

Tillämpade profiler

I tillämpade profiler används MS för alla element som identifierats under Upstream work eller via Informationsmodell som informationsbärande element som tillämpningen nyttjar i något av användningsfallen.

Definition

Alla element som markerats som Must Support enligt anvisningen Must support, skall ha en beskrivning av den profil-specifika tillämpningen i Element.definition. Exempel i FSH:

* period ^definition = "The time period of this Encounter"

Värdet på egenskapen Element.definition syns i en IG:

  • i vyn Content, som tooltip/hover-over på elementnamnet
  • i vyn Detailed Descriptions, som Definition på elementet i tabellen

Comment

Om det finns anvisningar för ett element som inte kan anges som formella regler skall dessa anges i Element.comment. Till exempel kan det användas för att ange att ett element av typen Reference skall referera till en inline-resurs och inte en resurs som behöver hämtas separat.

* account ^comment = "The Account used to reference a Payment Commitment (Betalningsförbindelse) SHALL be an inline VGRReimbursementAccount"

Värdet på egenskapen “comment” syns på en profil i en IG:

  • i vyn Detailed Descriptions, som Comment på elementet i tabellen

Example

Element som profilerats att värdesättas enligt specifika riktlinjer, t ex avseende format, kan med fördel exemplifieras direkt i profilen. Element.example består av en label och en valueString. OBS! Eftersom Element.example är en array kan elementet innehålla flera exempelvärden varför det är viktigt att märka varje exempel med en beskrivande label.

Exempel i FSH:

* identifier[LRID].value ^example[+].
  * label = "LRID"
  * valueString = "19810829M071"

Dylika exempelvärden kan lämpligtvis återanvändas i exempelinstanser av den profilerade resursen.

Notera att exempelvärden definierade i basprofiler ärvs automatiskt genom mekanism i IG Publisher vilket kan resultera i flera exempel på ett och samma element.

Kardinalitet

Basprofiler är följer prinicipen Löst begränsad och här bör grundresursens kardinalitet endast i undantagsfall ändras. I tillämpningsprofiler kan kardinaliteten begränsas om det finns behov uttryckt i användningsfall. Undvik dock att införa begränsningar om dessa inte tydligt tillför nytta för interoperabiliteten.

Business identifier

De profiler som hanterar information där källsystemet har en businiess identifier, tex ett vårdkontaktsID, SKALL inkludera detta i sin profil med elementet .identifier.

Elementet ska sättas som MS eftersom samtliga inblandade ska kunna hantera informationen, däremot ska det vara 0..1 eftersom det kan finnas situationer där informationen saknas.

Exempel på profil

Profile: VGRReimbursementEncounter
Id: VGRReimbursementEncounter
Description: "The Encounter-resource profiled for Healthcare Reimbursement in VGR."
Title: "VGR Reimbursement Encounter"
Parent: VGRBaseEncounter

* ^status = #active
* ^experimental = false

* identifier MS
* identifier ^definition = "Unique business identifier for this Encounter from the source system"
* identifier ^comment = "A business identifier SHALL exist with use='official'"

* class MS
* class ^definition = "The Vårdform of this Encounter"
* class from VGRKVVardformVS (required)

* serviceType MS
* serviceType ^definition = "The MVO-kod of this Encounter"
* serviceType from VGRKVMedicinsktVerksamhetsOmradeVS (required)

* period MS
* period ^definition = "The time period of this Encounter"
* period ^comment = "The period SHALL include the start time of the Encounter"

* account MS
* account ^definition = "The billing information for this Encounter, used to carry information about the Payment Commitment (Betalningsförbindelse) for this Encounter, if such exists"
* account ^comment = "The Account used to reference a Payment Commitment (Betalningsförbindelse) SHALL be an inline VGRReimbursementAccount"
* account only Reference(VGRReimbursementAccount)

* extension contains SarskildBetalarstatusExtension named sarskildBetalarstatus 0..1 MS

Platshållare för obligatoriska element

Den konstruktion som beskrivs nedan skall användas i följande scenario:

  • En profilerad resurs ABC används i en tillämpning
  • Resursen innehåller en ärvd (från basprofil eller FHIR-standard) obligatorisk referens till ett informationsobjekt XYZ i form av elementet ABC.REF (kardinalitet 1..n)
  • Det informationsobjekt som referensen ABC.REF beskriver är inte tillgängligt (eller inte relevant) i ett eller flera användningsfall

Den profilerade resursen kan inte tillämpa en mindre strikt kardinalitet och en referens behöver därför anges i den nya resursen. Detta hanteras på följande sätt för informationsobjektet XYZ.

Platshållar-objekt

Ett platshållar-objekt för XYZ definieras som:

Instance: VGRXYZPlaceholder
InstanceOf: <den resurstyp som refereras, t.ex. Organization>
Title: "VGRXYZPlaceholder"
Description: "XYZ placeholder used in... (scenario)"
Usage: #inline
* id = "VGRXYZPlaceholder"
* identifier.value = "VGRXYZPlaceholder"

Exempel för ABC = Coverage, REF = payor, XYZ = PayorOrganization:

Instance: VGRPayorOrganizationPlaceholder
InstanceOf: Organization
Title: "VGRPayorOrganizationPlaceholder"
Description: "Unknown Payor organization placeholder used in VGR Reimbursement profiles"
Usage: #inline
* id = "VGRPayorOrganizationPlaceholder"
* identifier.value = "VGRPayorOrganizationPlaceholder

Profil

Profilen definieras med ett statiskt värde för den aktuella referensen, vilket förklaras i beskrivningen:

Description: "...
NB: ABC is constrained to 1..n and must point to the contained instance of VGRXYZPlaceholder."

* ABC.reference = "#VGRXYZPlaceholder"
* ABC ^definition = "XYZ set to static instance VGRXYZPlaceholder"

Exempel:

Description: "...
NB: Payor is constrained to 1..1 and must point to the contained instance of VGRPayorOrganizationPlaceholder."

* payor.reference = "#VGRPayorOrganizationPlaceholder"
* payor ^definition = "Payor - set to the static instance VGRPayorOrganizationPlaceholder to meet cardinality 1..1"