ISiK CapabilityStatement Medikation Server - Medikationsinformation - Konformitätserklärung (CapabilityStatement)

Beschreibung

Dieses CapabilityStatement beschreibt alle Interaktionen, die ein System unterstützen MUSS, welches diese Rolle implementiert.

Die CapabilityStatements in dieser Spezifikation stellen die Anforderungen seitens der gematik dar (kind = requirements). Zur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die CapabilityStatement-Expectation-Extension mit den möglichen Werten SHALL (=MUSS) und MAY (=KANN) verwendet.

Zweck

Das vorliegende CapabilityStatement beschreibt alle verpflichtenden Interaktionen die ein ISiK-konformes System unterstützen muss um das Bestätigungsverfahren des Moduls 'Medikation', Bereich 'Medikationsinformation' zu bestehen.

HISTORIE:

  • change Die Verbindlichkeit des Suchparameters subject wurde von SHALL auf MAY reduziert, da der Suchparameter patient für ISiK-Zwecke ausreichend ist.
  • change Die Verbindlichkeit von Include und RevInclude wurde von SHALL auf MAY reduziert, außer bei den Parameter patient und encounter, da diese für ISiK-Zwecke ausreichend sind.
CanonicalURLhttps://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementMedikationInformationRolle
Intentionrequirements
Statusactive
Version5.1.2

Anforderungen an die FHIR-API

Modusserver

Interaktionen

RessourcentypVerbindlichkeitREADSEARCHCREATEUPDATE
ListSHALLSHALLSHALLSHALLSHALL
MedicationStatementSHALLSHALLSHALLSHALLSHALL

Profile

RessourcentypProfile
Listhttps://gematik.de/fhir/isik/StructureDefinition/ISiKMedikationsListe
MedicationStatementhttps://gematik.de/fhir/isik/StructureDefinition/ISiKMedikationsInformation

Ressourcentyp-spezifische Operations

Globale Operations

Dokumenten-Endpunkt

Suchparameter

RessourcenTypSuchParameterVerbindlichkeitHinweiseDefinition
MedicationStatement_idSHALL

Beispiel: GET [base]/[Resourcetype]?_id=103270 Anwendungshinweis: Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten: GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
MedicationStatement_countSHALL

Beispiel: GET [base]/[Resourcetype]?_count=100 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

MedicationStatement_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben GET [base]/Patient?_has:Observation:patient:code=1234-5 Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde GET [base]/Encounter?_has:Condition:encounter:code=A12.3 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

MedicationStatement_tagMAY

Beispiel: GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
MedicationStatementcodeSHALL

Beispiel:
GET [base]/MedicationStatement?code=http://fhir.de/CodeSystem/bfarm/atc|V03AB23

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Token-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Token Search'](https://hl7.org/fhir/R4/search.html#token).

http://hl7.org/fhir/SearchParameter/clinical-code
MedicationStatementcontextSHALL

Beispiel:
GET [base]/MedicationStatement?context=Encounter/123

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).

http://hl7.org/fhir/SearchParameter/MedicationStatement-context
MedicationStatementcontext.identifierSHALL

Beispiele:
GET [base]/MedicationStatement?context.identifier=http://mein-krankenhaus.example/fhir/sid/kontaktfallnummern|7567867

    `GET [base]/MedicationStatement?context.identifier=7567867`

**Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).

Weitere Informationen zur Suche nach verketteten Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Chained Parameters'](https://hl7.org/fhir/R4/search.html#chaining).

http://hl7.org/fhir/SearchParameter/MedicationStatement-context
MedicationStatementmedication.codeSHALL

Beispiel:
GET [base]/MedicationStatement?medication.code=http://fhir.de/CodeSystem/bfarm/atc|V03AB23

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Token-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Token Search'](https://hl7.org/fhir/R4/search.html#token).

Weitere Informationen zur Suche nach verketteten Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Chained Parameters'](https://hl7.org/fhir/R4/search.html#chaining).

http://hl7.org/fhir/SearchParameter/medications-medication
MedicationStatementpatient.identifierSHALL

Beispiele:
GET [base]/MedicationStatement?patient.identifier=http://mein-krankenhaus.example/fhir/sid/patienten|1032702

    `GET [base]/MedicationStatement?patient.identifier=1032702`

**Anwendungshinweise:** Weitere Informationen zur Suche nach Token-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Token Search'](https://hl7.org/fhir/R4/search.html#token).

Weitere Informationen zur Suche nach verketteten Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Chained Parameters'](https://hl7.org/fhir/R4/search.html#chaining).

http://hl7.org/fhir/SearchParameter/clinical-patient
MedicationStatementeffectiveSHALL

Beispiel:
GET [base]/MedicationStatement?effective=2022-03-21

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Date-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Date'](https://hl7.org/fhir/R4/search.html#date).

http://hl7.org/fhir/SearchParameter/MedicationStatement-effective
MedicationStatementmedicationSHALL

Beispiel:
GET [base]/MedicationStatement?medication=Medication/123

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).

http://hl7.org/fhir/SearchParameter/medications-medication
MedicationStatementpart-ofSHALL

Beispiel:
GET [base]/MedicationStatement?part-of=MedicationAdministration/789

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).

http://hl7.org/fhir/SearchParameter/MedicationStatement-part-of
MedicationStatementpatientSHALL

Beispiel:
GET [base]/MedicationStatement?patient=Patient/123

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).

http://hl7.org/fhir/SearchParameter/clinical-patient
MedicationStatementstatusSHALL

Beispiel:
GET [base]/MedicationStatement?status=active

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Token-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Token Search'](https://hl7.org/fhir/R4/search.html#token).

http://hl7.org/fhir/SearchParameter/medications-status
List_idSHALL

Beispiel: GET [base]/[Resourcetype]?_id=103270 Anwendungshinweis: Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten: GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

http://hl7.org/fhir/SearchParameter/Resource-id
List_countSHALL

Beispiel: GET [base]/[Resourcetype]?_count=100 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

List_hasMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben GET [base]/Patient?_has:Observation:patient:code=1234-5 Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde GET [base]/Encounter?_has:Condition:encounter:code=A12.3 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

List_tagMAY

Beispiel: GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

http://hl7.org/fhir/SearchParameter/Resource-tag
ListcodeSHALL

Beispiel:
GET [base]/List?code=http://terminology.hl7.org/CodeSystem/list-example-use-codes|medications

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Token-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Token Search'](https://hl7.org/fhir/R4/search.html#token).

http://hl7.org/fhir/SearchParameter/clinical-code
ListdateSHALL

Beispiel:
GET [base]/List?date=2022-03-21

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Date-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Date'](https://hl7.org/fhir/R4/search.html#date).

http://hl7.org/fhir/SearchParameter/clinical-date
ListencounterSHALL

Beispiel:
GET [base]/List?encounter=Encounter/123

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).

http://hl7.org/fhir/SearchParameter/clinical-encounter
ListitemSHALL

Beispiel:
GET [base]/List?item=MedicationStatement/131415

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).

http://hl7.org/fhir/SearchParameter/List-item
ListpatientSHALL

Beispiel:
GET [base]/List?patient=Patient/123

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).

http://hl7.org/fhir/SearchParameter/clinical-patient
ListstatusSHALL

Beispiel:
GET [base]/List?status=current

    **Anwendungshinweise:** Weitere Informationen zur Suche nach Token-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Token Search'](https://hl7.org/fhir/R4/search.html#token).

http://hl7.org/fhir/SearchParameter/List-status
Listencounter.identifierSHALL

Beispiele:
GET [base]/List?encounter.identifier=http://mein-krankenhaus.example/fhir/sid/fallnummern|7567867

    `GET [base]/List?encounter.identifier=7567867`

**Anwendungshinweise:** Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Reference Search'](https://www.hl7.org/fhir/R4/search.html#reference).

Weitere Informationen zur Suche nach verketteten Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Chained Parameters'](https://hl7.org/fhir/R4/search.html#chaining).

http://hl7.org/fhir/SearchParameter/clinical-encounter
Listpatient.identifierSHALL

Beispiele:
GET [base]/List?patient.identifier=http://mein-krankenhaus.example/fhir/sid/patienten|1032702

    `GET [base]/List?patient.identifier=1032702`

**Anwendungshinweise:** Weitere Informationen zur Suche nach Token-type Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Token Search'](https://hl7.org/fhir/R4/search.html#token).

Weitere Informationen zur Suche nach verketteten Parametern finden sich in der [FHIR-Basisspezifikation - Abschnitt 'Chained Parameters'](https://hl7.org/fhir/R4/search.html#chaining).

http://hl7.org/fhir/SearchParameter/clinical-patient

(Reverse-)Include

RessourcenTyptable
MedicationStatement
MedicationStatement:medication (SHALL)
MedicationStatement:patient (SHALL)
MedicationStatement:context (SHALL)
List
List:patient (SHALL)
List:encounter (SHALL)
List:item (SHALL)