Katalog (CodeSystem)
ISiKCodeSystem
Dieses Profil beschreibt die maschinenlesbare Repräsentation von system-spezifischen Kodierungen in ISiK-Szenarien.
Motivation
ISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus-/System-interne Kodierungen. Das Profil ISiKKatalog (CodeSystem) als Profil erlaubt die Repräsentation der dazugehörigen Codes und Display-Werte.
Eine maschinenlesbare Repräsentation dieser Kodierungen erlaubt es Clients, dazugehörige Anzeigetext und Definitionen zu verarbeiten.
Ein Codesystem eignet sich auch dazu, auf dessen Basis definierte ValueSets zu expandieren. Da ISiKValueSet expandierte Valuesets vorsieht, ist eine dynamische Expansion in der Regel nicht erforderlich. Darüber hinausgehend ist ein Use Case im Kontext der Katalogabfrage folgender: Ein Client möchte eine Expansion neu generieren (z.B. mit anderen Expansionen-Parametern), um das ValueSet beispielsweise in einer anderen Sprache auszugeben.
Bestätigungsrelevanz
| Verbindlichkeit | MAY |
|---|
Metadaten
| Canonical | https://gematik.de/fhir/isik/StructureDefinition/ISiKCodeSystem |
|---|---|
| Status | active |
| Version | 5.1.0 |
| Basis | http://hl7.org/fhir/StructureDefinition/CodeSystem |
Inhalt
| ISiKCodeSystem (CodeSystem) | C | CodeSystem | |
| id | S Σ | 0..1 | string |
| meta | Σ | 0..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | Σ | 0..* | canonical(StructureDefinition) |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| url | S Σ | 1..1 | uri |
| identifier | Σ | 0..* | Identifier |
| version | S Σ | 1..1 | string |
| name | S Σ C | 1..1 | string |
| title | Σ | 0..1 | string |
| status | S Σ ?! | 1..1 | codeBinding |
| experimental | Σ | 0..1 | boolean |
| date | Σ | 0..1 | dateTime |
| publisher | Σ | 0..1 | string |
| contact | Σ | 0..* | ContactDetail |
| description | 0..1 | markdown | |
| useContext | Σ | 0..* | UsageContext |
| jurisdiction | Σ | 0..* | CodeableConceptBinding |
| purpose | 0..1 | markdown | |
| copyright | 0..1 | markdown | |
| caseSensitive | Σ | 0..1 | boolean |
| valueSet | Σ | 0..1 | canonical(ValueSet) |
| hierarchyMeaning | Σ | 0..1 | codeBinding |
| compositional | Σ | 0..1 | boolean |
| versionNeeded | Σ | 0..1 | boolean |
| content | S Σ | 1..1 | codeBinding |
| supplements | Σ | 0..1 | canonical(CodeSystem) |
| count | Σ | 0..1 | unsignedInt |
| filter | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| code | Σ | 1..1 | code |
| description | Σ | 0..1 | string |
| operator | Σ | 1..* | codeBinding |
| value | Σ | 1..1 | string |
| property | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| code | Σ | 1..1 | code |
| uri | Σ | 0..1 | uri |
| description | Σ | 0..1 | string |
| type | Σ | 1..1 | codeBinding |
| concept | S | 1..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| code | S | 1..1 | code |
| display | S | 1..1 | string |
| definition | S | 0..1 | string |
| designation | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| language | 0..1 | codeBinding | |
| use | 0..1 | CodingBinding | |
| value | 1..1 | string | |
| property | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| code | 1..1 | code | |
| value[x] | 1..1 | ||
| valueCode | code | ||
| valueCoding | Coding | ||
| valueString | string | ||
| valueInteger | integer | ||
| valueBoolean | boolean | ||
| valueDateTime | dateTime | ||
| valueDecimal | decimal | ||
| concept | 0..* | see (concept) |
Constraints/Invarianten
Interaktionen
| Interaktion | Verbindlichkeit |
|---|---|
| read | MAY |
| search-type | MAY |
| Parameter | Typ | Verbindlichkeit | Hinweise |
|---|---|---|---|
| _id | token | SHALL | Beispiel:
|
| _tag | token | SHALL | Beispiel:
|
| _count | number | SHALL | Beispiel:
|
| _has | string | MAY | Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben
|
| url | uri | MAY | Beispiel: |
(Reverse-)Include
Anmerkungen zu Must-Support-Feldern
| Feldname | Kurzbeschreibung | Hinweise |
|---|---|---|
| CodeSystem.id | serverseitige, interne ID des Datensatzes | bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine |
| CodeSystem.url | Kanonische URL | Bedeutung: Eindeutige Url zur Identifizierung des CodeSystems. Absolute Url sind zu bevorzugen. |
| CodeSystem.version | Version | Bedeutung: Version des CodeSystems |
| CodeSystem.name | Name des Codesystems | Bedeutung: Maschinenlesbarer Name des CodeSystems |
| CodeSystem.status | Status | Zeigt den aktuellen Status der Ressource an.
|
| CodeSystem.content | Vollständigkeit der Repräsentation | Bedeutung: Angabe, ob es sich um eine vollständige Repräsentation des CodeSystems oder nur um einen Auszug handelt.
Hinweise: Alle in einem System möglichen Status-Werte müssen über FHIR korrekt repräsentiert werden können, mindestens jedoch die Status-Werte |
| CodeSystem.concept | Konzept | Bedeutung: Angabe der Konzepte, aus denen sich das CodeSystem zusammensetzt. |
| CodeSystem.concept.code | Code | Der eindeutige Code, der das Konzept im CodeSystem identifiziert. |
| CodeSystem.concept.display | Anzeigetext | Die menschlich lesbare Darstellung des Konzepts. |
| CodeSystem.concept.definition | Definition | Eine ausführliche Beschreibung oder Definition des Konzepts. |