Katalog (CodeSystem)
Motivation
ISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus- / Systeminterne Kodierungen. Eine maschinenlesbare Repräsentation dieser Kodierungen erlaubt es Clients dazugehörige Anzeigetext und Definitionen zu verarbeiten.
FHIR-Profil
| Name | Canonical |
|---|---|
| ISiKCodeSystem | https://gematik.de/fhir/isik/v2/Basismodul/StructureDefinition/ISiKCodeSystem |
| CodeSystem | I | CodeSystem | |
| id | S Σ | 1..1 | System.String |
| url | S Σ | 1..1 | uri |
| identifier | Σ | 0..* | Identifier |
| version | S Σ | 1..1 | string |
| name | S Σ I | 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 |
| code | Σ | 1..1 | code |
| description | Σ | 0..1 | string |
| operator | Σ | 1..* | codeBinding |
| value | Σ | 1..1 | string |
| property | Σ | 0..* | BackboneElement |
| code | Σ | 1..1 | code |
| uri | Σ | 0..1 | uri |
| description | Σ | 0..1 | string |
| type | Σ | 1..1 | codeBinding |
| concept | S | 1..* | BackboneElement |
| code | S | 1..1 | code |
| display | S | 1..1 | string |
| definition | S | 0..1 | string |
| designation | 0..* | BackboneElement | |
| language | 0..1 | codeBinding | |
| use | 0..1 | CodingBinding | |
| value | 1..1 | string | |
| property | 0..* | BackboneElement | |
| 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) |
Interaktionen
Für die Ressource CodeSystem MUSS die REST-Interaktion "READ" implementiert werden.
Folgende Suchparameter sind für das Bestätigungsverfahren relevant, auch in Kombination:
Der Suchparameter "_id" MUSS unterstützt werden:
Beispiele:
GET [base]/CodeSystem?_id=103270Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "url" MUSS unterstützt werden:
Beispiele:
GET [base]/CodeSystem?url=http://example.org/fhir/CodeSystem/testAnwendungshinweise: Weitere Informationen zur Suche nach "CodeSystem.url" finden sich in der FHIR-Basisspezifikation - Abschnitt "uri".
Der Suchparameter "name" MUSS unterstützt werden:
Beispiele:
GET [base]/CodeSystem?name=TestCodeSystemAnwendungshinweise: Weitere Informationen zur Suche nach "CodeSystem.name" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".
Der Suchparameter "status" MUSS unterstützt werden:
Beispiele:
GET [base]/CodeSystem?status=activeAnwendungshinweise: Weitere Informationen zur Suche nach "CodeSystem.status" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search"".
Der Suchparameter "version" MUSS unterstützt werden:
Beispiele:
GET [base]/CodeSystem?version=1.0.0Anwendungshinweise: Weitere Informationen zur Suche nach "CodeSystem.version" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "content-mode" MUSS unterstützt werden:
Beispiele:
GET [base]/CodeSystem?content-mode=completeAnwendungshinweise: Weitere Informationen zur Suche nach "CodeSystem.content" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Anmerkungen zu Must-Support-Feldern
CodeSystem.url
Bedeutung: Eindeutige Url zur Identifizierung des CodeSystems. Absolute Url sind zu bevorzugen.
Hinweise: OIDs SOLLTEN als weitere Identifier des CodeSystems verwendet werden. In jedem Fall SOLLTE ein Canonical Url vergeben werden.
CodeSystem.version
Bedeutung: Version des CodeSystems
Hinweise: Jede Änderung des CodeSystems MUSS eine Änderung in der Version des CodeSystems und gebundenen ValueSets nach sich ziehen. Die Versionierung SOLLTE auf Basis von Semantic Versioning basieren.
CodeSystem.name
Bedeutung: Maschinenlesbarer Name des CodeSystems
Hinweise: Der Constraint cps-0 ist hierbei zu beachten.
CodeSystem.status
Bedeutung: Indikation, ob das CodeSystem in aktiver Verwendung ist.
Hinweise: Alle in einem System möglichen Status-Werte MÜSSEN über FHIR korrekt repräsentiert werden. KÖNNEN mindestens jedoch die Status-Werte "active" und "retired". Deren korrekte Abbildung wird im Rahmen des Bestätigungsverfahrens überprüft.
CodeSystem.content
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 "fragment" und "complete". Deren korrekte Abbildung wird im Rahmen des Bestätigungsverfahrens überprüft.
CodeSystem.concept
Bedeutung: Angabe der Konzepte, aus denen sich das CodeSystem zusammensetzt.
Hinweise: Es MUSS mindestens ein Code und ein Anzeigetext spezifiziert werden.
Beispiele
Valides Minimalbeispiel CodeSystem:
{ "resourceType": "CodeSystem", "id": "CodeSystemExample", "meta": { "profile": [ "https://gematik.de/fhir/isik/v2/Basismodul/StructureDefinition/ISiKCodeSystem" ] }, "url": "http://example.org/fhir/CodeSystem/TestKatalog", "version": "1.0.0", "name": "TestKatalog", "status": "active", "content": "complete", "concept": [ { "code": "test", "display": "Test", "definition": "Dies ist ein Test-Code" } ] }