Document toolboxDocument toolbox

Meta (eHealth Metadata)

Doel

(FHIR) Meta is een set metadata die technische content meegeeft aan elke type FHIR resource. De metadata elementen zijn in FHIR R4 allemaal optioneel, echter in de context van Koppeltaal 2.0 gaan we enkele elementen in de implementatie vereisen. Zie hiervoor de cardinaliteit.

Referentie

FHIR Specification (v4.0.1: R4 - Mixed Normative and STU). Dit is de huidige gepubliceerde versie. Zie ook: https://www.hl7.org/fhir/resource.html#Meta

Koppeltaal 2.0 (draft) profiel van Meta

Element

Omschrijving

Card.

Type

versionId

De waarde van versionId verandert elke keer als de inhoud van de resource verandert. Er kan naar worden verwezen in een resource referentie (voorbeeld: ResourceType/id/_history/versionId). De versionId wordt bij Koppeltaal gebruikt om ervoor te zorgen dat updates altijd zijn gebaseerd op de nieuwste versie (of meest recente content) van de resource. De versie kan globaal uniek zijn, of binnen het bereik van de logische id van de resource.

VersionId's zijn over het algemeen ofwel een serieel oplopende identificatie binnen het bereik van de logische ID, ofwel een uuid, hoewel geen van deze beschrijvingen vereist is. Er is geen vaste volgorde voor de versionId's. Cliënten of afnemers mogen er niet van uitgaan dat een versionId die na een andere komt, numeriek of alfabetisch een latere versie vertegenwoordigt. Dezelfde versionId mag nooit worden gebruikt voor meer dan één versie van dezelfde resource.
RESTful API:

  • De versionId wordt in de HTTP ETag header bij elk antwoord meegegeven.
  • Bij ontvangst van een schrijfbewerking MOET de server dit item bijwerken naar de huidige waarde of het verwijderen.
  • Twee resources zijn identiek als de versionId's identiek zijn.
  • Alle services die in de context van Koppeltaal werken MOETEN het versionid  element ondersteunen.
  • Bij het aanpassen/wijzigen van de content van de resources moet men gebruik maken de versionId in combinatie met de If-Match HTTP header, om zo wijzigingen gecontroleerd door een FHIR service uit te laten voeren. Deze techniek heet "Optimistic Locking" en wordt bij RESTful APIs gebruikt omdat deze "stateless" zijn, hierdoor onthoudt de  FHIR service geen locks.
0..1Id
lastUpdated

Dit element verandert de waarde als de content van de resource verandert. Gebruik hier de tijdzonecode van de server waarop de FHIR service functioneert.

RESTful API:

  • Bij ontvangst van een schrijfbewerking MOET de FHIR (Resource) Provider dit item bijwerken naar de huidige tijd op de server
0..1instant
source

Wordt niet gebruikt binnen Koppeltaal 2.0

0..1string
profileEen bewering of toekenning dat de inhoud van de resource overeenkomt met een resource profile (vastgelegd in een StructureDefinition). Zie FHIR Profiles voor verdere uitleg. Een profile wordt gewijzigd als de waardensets wijzigen of  het systeem de conformiteit opnieuw controleert. De profile kan worden gebruikt om aan te geven aan welke versie(s) de FHIR resource moet voldoen. Een FHIR server kan ongeldige interacties afwijzen en testen aan de hand van de profile(s). 0..1canonical
tagLabels die aan een resource zijn toegewezen. Labels worden gebruikt om resources te kunnen identificeren en te relateren aan (security en werk) processen. Toepassingen hoeven de tags niet in beschouwing te nemen bij het interpreteren van een resource. 0..*coding