eEB
- eEB
Implementierungsleitfaden elektronische Ersatzbescheinigung (eEB/GKV)
Die UseCases der elektronischen Ersatzbescheinigung digitalisieren den papierbasierten Prozess für Anwendungsfälle in der (Zahn-)Arztpraxis, in denen keine eGK als Versicherungsnachweis vorgelegt werden kann. Der bisherige papierbasierte Prozess für die Übermittlung von Ersatzbescheinigungen wie bspw. Fax, Papierausstellung usw. und der anschließenden händischen Übernahme der Daten sind langwierig, fehleranfällig und unkomfortabel für einen Großteil der Beteiligten.
Mit dem eEB-Verfahren wird die Anforderung und Ausstellung einer Ersatzbescheinigung für Versicherte der gesetzlichen Krankenkassen automatisierbar.
Mit Verabschiedung des DigiG am 02.02.2024 können die Versicherten gemäß §291 SGB V Absatz (9) einen Nachweis der Berechtigung zur Inanspruchnahme von Leistungen im Rahmen der vertragsärztlichen Versorgung von ihrer gesetzlichen Krankenkasse für die Vorlage bei einem Leistungserbringer anfordern, der unmittelbar von der Krankenkasse über ein sicheres Übermittlungsverfahren nach § 311 Absatz 6 (KIM) an den Leistungserbringer übermittelt wird.
Die Leistungserbringer stellen dazu den Versicherten ihre KIM-Adresse in maschinenlesbarer Form zur Verfügung (QR-Code-Scan), damit die Versicherten die KIM-Adresse mit der eEB-Beantragung ihrer Kasse übermitteln können.
Damit Versicherte, die nicht über die technischen Voraussetzungen verfügen, an diesem KIM-Verfahren teilnehmen zu können, können den Leistungserbringer bitten, die Anforderung zur Ausstellung einer elektronischen Ersatzbescheinigung via KIM durch das Praxispersonal zu initiieren. In diesem Fall kann ein Leistungserbringer für eine zu behandelnde Person, die keine Gesundheitskarte als Versicherungsnachweis vorlegen kann, eine Anfrage einer Ersatzbescheinigung bei der von der Person benannten oder bereits im System bekannten Krankenkasse erfolgen. Damit die Kasse die versicherte Person in ihrem Bestandssystem identifizieren kann, müssen der Anfrage ein Mindestsatz an personenbezogenen Daten der versicherten Person mitgegeben werden.
Hinweis zur Behandlung auf Basis einer Ersatzbescheinigung
Werden dem Patienten im Rahmen der Behandlung Medikamente verschrieben, muss der Einlöseweg eines E-Rezepts für den Patienten berücksichtigt werden. Ist die mitgeführte eGK nicht funktionsfähig, sollte dem Patienten der E-Rezept-Einlösecode als Ausdruck mitgegeben werden.
UseCase und Funktionsweise (Anforderung aus der Praxis)
Die Anforderung zur Ausstellung einer Ersatzbescheinigung für eine gesetzlich versicherte Person kann durch das Praxispersonal initiiert werden. Für die Anforderung einer Ersatzbescheinigung muss in der Praxis ein minimaler Satz an Informationen zur zu behandelnden Person erfasst und aus dem Praxisverwaltungssystem via KIM an die bekannte bzw. benannte Kasse als Anfrage gesendet werden. Die Kasse erstellt zur angefragten Person automatisiert, anhand der in ihrem Backend vorliegenden Versicherungsdaten einen FHIR-Datensatz, der dann via KIM der Praxis zugestellt wird.
Das Praxisverwaltungssystem kann die bereits erfassten bzw. vorhandenen Patientendaten mit den von der Kasse bereitgestellten Versichertenstammdaten aktualisieren.
Erfassung personenbezogener Daten
Bei der Abfrage nach einer Ersatzbescheinigung zu einer Person sind zwei Fälle zu unterscheiden, ist die 10-stellige Versicherten-ID KVNR
der Person bekannt oder unbekannt. Da diese KVNR
für eine Person (i.d.R.) lebenslang gültig ist, ergibt sich die Antwort aus der Frage, ob der Patient in dieser Praxis in der Vergangenheit bereits vorstellig war.
Es hat sich bei Nutzung der KVNR als sinnvoll erwiesen, die KVNR vor Verwendung in der EEB-Anfrage ggf. einmal formal zu prüfen (Länge, Aufbau und Prüfziffer - siehe auch https://gkv-datenaustausch.de/kvnr/kvnr.jsp). Diese Hinweise helfen, Tippfehler zu vermeiden.
Patient ist im PVS bekannt
Um der Kasse Hilfe zum Auffinden der versicherten Person in ihrem Bestandssystem zu geben, müssen personenbezogene Informationen in einer FHIR-Ressource Patient
mitgegeben werden. Ist die Person bereits im PVS als Patient hinterlegt (wurden bspw. in der Vergangenheit Behandlungen in der Praxis durchgeführt) können die Daten in einer Patienten-Ressource KBV_PR_FOR_Patient
zusammengefasst werden, wie sie in anderen formularbasierten Anwendungen bereits genutzt wird. Es genügt auch der Eintrag der kvnr
im identifier
einer KnownPatient
-Ressource. Weitere Angaben sind optional.
EEBKnownPatient (Patient) | I | Patient | There are no (further) constraints on this element Element idPatient Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idPatient.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idPatient.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | Σ | 1..1 | canonical(StructureDefinition)Fixed Value | Element idPatient.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
https://gematik.de/fhir/eeb/StructureDefinition/EEBKnownPatient |
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idPatient.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
identifier | S Σ | 1..1 | Identifier | Element idPatient.identifier An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. Unordered, Closed, by system(Value) Constraints
|
versichertenId_GKV | Σ | 0..1 | IdentifierKvid10 | Element idPatient.identifier:versichertenId_GKV An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Patients are almost always assigned specific numerical identifiers.
|
versichertenID_pkv | Σ | 0..1 | Element idPatient.identifier:versichertenID_pkv An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Patients are almost always assigned specific numerical identifiers.
| |
active | Σ ?! | 0..0 | boolean | There are no (further) constraints on this element Element idPatient.active Whether this patient's record is in active use DefinitionWhether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. Need to be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. This resource is generally assumed to be active if no value is provided for the active element
|
name | Σ | 0..0 | HumanName | There are no (further) constraints on this element Element idPatient.name A name associated with the patient DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.
|
telecom | Σ | 0..0 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
|
gender | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idPatient.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. The gender of a person used for administrative purposes.
|
birthDate | Σ | 0..0 | date | There are no (further) constraints on this element Element idPatient.birthDate The date of birth for the individual DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).
|
deceased[x] | Σ ?! | 0..0 | There are no (further) constraints on this element Element idPatient.deceased[x] Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
| |
address | Σ | 0..0 | Address | There are no (further) constraints on this element Element idPatient.address An address for the individual DefinitionAn address for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Patient may have multiple addresses with different uses or applicable periods.
|
maritalStatus | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatus Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. The domestic partnership status of a person.
| |
multipleBirth[x] | 0..0 | There are no (further) constraints on this element Element idPatient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).
| ||
photo | 0..0 | Attachment | There are no (further) constraints on this element Element idPatient.photo Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Guidelines:
| |
contact | I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.contact A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.
|
communication | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.communication A language which may be used to communicate with the patient about his or her health DefinitionA language which may be used to communicate with the patient about his or her health. If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
| |
generalPractitioner | 0..0 | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitioner Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. Reference(Organization | Practitioner | PractitionerRole) Constraints
| |
managingOrganization | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).
|
link | Σ ?! | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.link Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple use cases:
There is no assumption that linked patient records have mutual links.
|
Patient ist im PVS unbekannt
Ist die zu behandelnde Person als Patient im PVS unbekannt, sind folgende Angaben mindestens erforderlich, um der Kasse eine Suche nach einem Versichertenverhältnis zu ermöglichen:
- Der Familienname
name
- mindestens ein Vorname
given
- die Postleitzahl
postalCode
der Wohnaddress
(Straßenname und Hausnummer sind nicht erforderlich) und - das
birthDate
Diese Angaben sind in einer Patienten-Ressource KBV_PR_FOR_Patient
einzutragen.
Es wird empfohlen, dass das Praxispersonal darauf hingewiesen wird, die versicherte Person nach der aktuellen Krankenkasse zu befragen und ggfs. die hinterlegte Krankenkasse für die Anfrage zu aktualisieren.
Angaben zur anfragenden Praxis
Die Kasse benötigt für die Ausstellung einer Ersatzbescheinigung Informationen über die anfragende Praxis, um das Ausstellen von "Blanko"-Bescheinigungen zu unterbinden.
Dazu muss jeder Anfrage eine FHIR-Ressource Organization
des Profils KBV_PR_FOR_Organization mitgegeben werden.
Die Anfrage muss entweder die Betriebsstättennummer BSNR
, die KZV Abrechnungsnummer KZVA
, Standortnummer des Krankenhauses oder das Institutionskennzeichen enthalten, um die anfragende Praxis zu identifizieren, zusätzlich kann die TelematikID
angegeben werden.
Ebenso müssen die Angaben zur address
und telecom
-Kontaktinformationen für Rückfragen angegeben sein.
Signatur der Anfrage
Die Anfrage (das FHIR-Bundle) muss mittels der Institutionsidentität (SMC-B OSIG) signiert werden, um der angefragten Kasse einen Authentizitäts-Nachweis bereitzustellen. Die Signatur der KIM-Nachricht reicht dabei nicht aus, da diese nur die Integrität des Transports und Authentizität des KIM-Absenders sicherstellt, aber nicht, ob der Absender auch tatsächlich die Institution ist, gegenüber der der Patient eingewilligt hat. Daher ist der FHIR-Datensatz als Base64-Codierter PKCS#7-Container bereitzustellen (enveloping Signatur) in die KIM-Anfrage einzubetten.
Mittels der Konnektoroperation signDocument
wird die Signatur erstellt.
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:m0="http://ws.gematik.de/conn/ConnectorCommon/v5.0" xmlns:m1="http://ws.gematik.de/conn/ConnectorContext/v2.0" xmlns:m2="urn:oasis:names:tc:dss:1.0:core:schema" xmlns:m3="http://www.w3.org/2000/09/xmldsig#" xmlns:m4="urn:oasis:names:tc:dss-x:1.0:profiles:SignaturePolicy:schema#"> <SOAP-ENV:Body> <m:SignDocument xmlns:m="http://ws.gematik.de/conn/SignatureService/v7.4"> <m0:CardHandle>SMCB1</m0:CardHandle> <m1:Context> <m0:MandantId>Mandant1</m0:MandantId> <m0:ClientSystemId>ClientID1</m0:ClientSystemId> <m0:WorkplaceId>Tisch2</m0:WorkplaceId> <m0:UserId>4711</m0:UserId> </m1:Context> <m:TvMode>NONE</m:TvMode> <m:JobNumber>MMD-636</m:JobNumber> <m:SignRequest RequestID="Doc1"> <m:OptionalInputs> <m2:SignatureType>urn:ietf:rfc:5652</m2:SignatureType> <m:IncludeEContent>true</m:IncludeEContent> </m:OptionalInputs> <m:Document ID="CMS-Doc1" ShortText="eEB-Anfrage"> <m2:Base64Data MimeType="text/plain; charset=utf-8">PEJ1bmRsZSB4bWxucz0iaHR0cDovL2hsNy5vcmcvZmhpciI +CiAgICA8aWQgdmFsdWU9IjFmMzExYzQwLWZlZTktNGIwMy1iMGM0LWMyOWQ0MzJmMjM3MSIgLz4K ICAgIDxtZXRhPgogICAgICAgIDwhLS0gZWluIHN0YXJrIGdla/xyenRlcyBCZWlzcGllbCAtLT4KI CAgIDwvbWV0YT4KICAgIDxpZGVudGlmaWVyPgogICAgICAgIDxzeXN0ZW0gdmFsdWU9InVybjppZX RmOnJmYzozOTg2IiAvPgogICAgICAgIDx2YWx1ZSB2YWx1ZT0idXJuOnV1aWQ6Nzk5MzllMzQtYzV jYy00ZGE2LWJhNTUtZjRiZDg1ODMyNzYwIiAvPgogICAgPC9pZGVudGlmaWVyPgogICAgPHRpbWVz dGFtcCB2YWx1ZT0iMjAyMi0wOC0yOVQwMjoxMDozNy4xNTQrMDI6MDAiIC8+CjwvQnVuZGxlPg==</m2:Base64Data> </m:Document> <m:IncludeRevocationInfo>true</m:IncludeRevocationInfo> </m:SignRequest> </m:SignDocument> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Hinweis: Der ShortText darf nicht länger als 30 Zeichen sein.
Im Ergebnis liefert der Konnektor eine SignDocumentResponse
, die anschließend in die zu verschickende KIM-Anfrage eingebettet wird.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns8:SignDocumentResponse xmlns:ns10="urn:oasis:names:tc:dss-x:1.0:profiles:verificationreport:schema#" xmlns:ns11="http://uri.etsi.org/01903/v1.3.2#" xmlns:ns12="http://uri.etsi.org/02231/v2#" xmlns:ns2="http://ws.gematik.de/conn/EncryptionService/v6.1" xmlns:ns3="http://ws.gematik.de/conn/ConnectorCommon/v5.0" xmlns:ns4="http://ws.gematik.de/conn/ConnectorContext/v2.0" xmlns:ns5="urn:oasis:names:tc:dss:1.0:core:schema" xmlns:ns6="http://www.w3.org/2000/09/xmldsig#" xmlns:ns7="http://ws.gematik.de/tel/error/v2.0" xmlns:ns8="http://ws.gematik.de/conn/SignatureService/v7.4" xmlns:ns9="urn:oasis:names:tc:dss-x:1.0:profiles:SignaturePolicy:schema#"> <ns8:SignResponse RequestID="Doc1"> <ns3:Status> <ns3:Result>OK</ns3:Result> </ns3:Status> <ns8:OptionalOutputs> <ns8:DocumentWithSignature ID="CMS-Doc1" ShortText="eEB-Anfrage"> <ns5:Base64Data MimeType="text/plain; charset=utf-8"/> </ns8:DocumentWithSignature> </ns8:OptionalOutputs> <ns5:SignatureObject> <ns5:Base64Signature Type="urn:ietf:rfc:5652">TG9yZW0gSW1zcHVtIQpJIGFtIGEgQ0FkRVMgZW52ZWxvcGluZyBzaWdudGF0dXJlIG9mIGEgZUVCL UFuZnJhZ2UgRkhJUi1CdW5kbGUgaW4gWE1MIHJlcHJlc2VudGF0aW9uLg==</ns5:Base64Signature> </ns5:SignatureObject> </ns8:SignResponse> </ns8:SignDocumentResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
KIM-Empfängeradresse der Krankenkasse
Die Suche nach der KIM-Empfängeradresse der Kasse erfolgt im zentralen Verzeichnisdienst VZD. Folgendes Beispiel für einen Konsolenaufruf mittels ldapsearch
im VZD der TI-Referenzumgebung RU mit der Suche nach einer Krankenkasse OID=1.2.276.0.76.4.59
und Teil des Namens Techniker
in einem kombinierten LDAP-Filter (&(professionOID=1.2.276.0.76.4.59)(displayName=Techniker*))
:
ldapsearch -x -H ldaps://10.24.11.11:1636 -b dc=data,dc=vzd "(&(professionOID=1.2.276.0.76.4.59)(displayName=Techniker*))"
Zur Vereinfachung der Praxisabläufe sollte die Suche ins Praxisverwaltungssystem integriert werden.
Bei bekannten Patienten kann die KIM-Adresse aus dem Verzeichnisdienst über den Filter des Haupt-IK (gemäß er Kostenträgerstammdatei) der Krankenkasse abgefragt werden
(XML-Element ./kostentraeger/ik_liste/ik@V
).
Hier der Einfachheit halber ebenfalls als Konsolenaufruf:
ldapsearch -x -H ldaps://10.24.11.11:1636 -b dc=data,dc=vzd "(&(domainID=101577501)(entryType=5))"
Diese liefert folgendes Ergebnis
# extended LDIF
#
# LDAPv3
# base <dc=data,dc=vzd> with scope subtree
# filter: (&(domainID=101577501)(entryType=5))
# requesting: ALL
#
# fc695fd6-b6e9-4754-9684-fee70f743086, data.vzd
dn: uid=fc695fd6-b6e9-4754-9684-fee70f743086,dc=data,dc=vzd
objectClass: vzd-komleview
objectClass: top
mail: tk-intern@akquinet.kim.telematik-test
mail: tk-dt03@akquinet.kim.telematik-test
mail: tk-dt01@akquinet.kim.telematik-test
mail: tk-dt02@akquinet.kim.telematik-test
mail: tk-dein@akquinet.kim.telematik-test
otherName: -
displayName: Techniker Krankenkasse
cn: Techniker Krankenkasse
organization: Techniker Krankenkasse NOT-VALID
userCertificate;binary:: MIIFQzCCBCugAwIBAgICBWIwDQYJKoZIhvcNAQELBQAwgbYxCzAJB
gNVBAYTAkRFMTowOAYDVQQKDDFULVN5c3RlbXMgSW50ZXJuYXRpb25hbCBHbWJIIC0gRzIgTG9zID
MgTk9ULVZBTElEMUgwRgYDVQQLDD9JbnN0aXR1dGlvbiBkZXMgR2VzdW5kaGVpdHN3ZXNlbnMtQ0E
gZGVyIFRlbGVtYXRpa2luZnJhc3RydWt0dXIxITAfBgNVBAMMGFRTWVNJLlNNQ0ItQ0EzIFRFU1Qt
T05MWTAeFw0yMTA3MTIwNzUzMTJaFw0yNjA3MTIyMzU5NTlaMIHFMQswCQYDVQQGEwJERTEQMA4GA
1UEBwwHSGFtYnVyZzEOMAwGA1UEEQwFMjIzMDUxHDAaBgNVBAkME0JyYW1mZWxkZXIgU3RyLiAxND
AxKTAnBgNVBAoMIFRlY2huaWtlciBLcmFua2Vua2Fzc2UgTk9ULVZBTElEMSAwHgYDVQQFExcxMi4
4MDI3NjAwMzQ0MTIwMDA3NTA4NTEpMCcGA1UEAwwgVGVjaG5pa2VyIEtyYW5rZW5rYXNzZSBURVNU
LU9OTFkwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCFAAwf1Xov5A8x4079MacZm3wb4
DFN2c0ugwZdvTZLWacLHWfWOUi4Ct06rxuSgsEcyX4P0uU/IDul+BDhpE3hjhV26eoQzHfbNbUl0O
DTSnWhBqEzjnG3bj4FNqK3rWkeZNmeR1mTp3PjtpPJ4mjGKDDXpNzj+2zhVLe54NI+G2HIllb0tWa
lmq/kmdQTafPTHjD6nhcKX7Di51/mLebNW8+xiWr3087RfsguxOpELdRzgsE4jYJ3nUNZSKZv3JIU
TsYwvhrg50gjPLh1XEelv4dcjJWDj0whmo1qEOKEw0AKnnKXnGRWNzFprVxR2Y0wyG5AG+QeSSiM1
mqVrvgHAgMBAAGjggFIMIIBRDAdBgNVHQ4EFgQUIamKsyVjeh+/jROwwH6/W8lQw5QwDgYDVR0PAQ
H/BAQDAgQwMAwGA1UdEwEB/wQCMAAwIAYDVR0gBBkwFzAKBggqghQATASBIzAJBgcqghQATARMMEI
GCCsGAQUFBwEBBDYwNDAyBggrBgEFBQcwAYYmaHR0cDovL29jc3Auc21jYi50ZXN0LnRlbGVzZWMu
ZGUvb2NzcHIwHwYDVR0jBBgwFoAUMz3U691kvP0AL8E2m1wVWEUrriwwfgYFKyQIAwMEdTBzpCwwK
jELMAkGA1UEBhMCREUxGzAZBgNVBAoMElNNLUIgS1RSIFN1YmRvbWFpbjBDMEEwPzA9MB8MHUJldH
JpZWJzc3TDpHR0ZSBLb3N0ZW50csOkZ2VyMAkGByqCFABMBDsTDzgtMDEtMDAwMDAwMDA5MDANBgk
qhkiG9w0BAQsFAAOCAQEAFgX+0xMfQujIxwpTk/oAOqEJ40LckYsCxs1nJPJlfo3xLdvwu7ADlnYQ
Zpv89/j+VVjsntSUknOQ508P6N1WsvEwW1knLTloCIUY8g0cAtbPFMjo9cJwuCFbip2vWJxUXVuFk
x4vTqMw24N+aXzfOoO1EYTusuvRasG3pdjzjBeGvMtWPjjPuXiSyHbyVn3zn3FkIP8ss4z7iLPLDM
gIm1MHwWVE5u/s1eKWgYm6H6O0D/3uwTAXA+sbTCGCW2CAizAqzCinZAgaFWslCMbSFxef2gUuFsp
OmpvYt4gnT3iQ6I5aSO5wSYKL/t1vsk8q5YTXmxFS641CIfM9RimalQ==
userCertificate;binary:: MIIDuTCCA2CgAwIBAgICAN8wCgYIKoZIzj0EAwIwgbgxCzAJBgNVB
AYTAkRFMTwwOgYDVQQKDDNEZXV0c2NoZSBUZWxla29tIFNlY3VyaXR5IEdtYkggLSBHMiBMb3MgMy
BOT1QtVkFMSUQxSDBGBgNVBAsMP0luc3RpdHV0aW9uIGRlcyBHZXN1bmRoZWl0c3dlc2Vucy1DQSB
kZXIgVGVsZW1hdGlraW5mcmFzdHJ1a3R1cjEhMB8GA1UEAwwYVFNZU0kuU01DQi1DQTQgVEVTVC1P
TkxZMB4XDTIxMDcxMjA3NTMxMloXDTI2MDcxMjIzNTk1OVowgcUxCzAJBgNVBAYTAkRFMRAwDgYDV
QQHDAdIYW1idXJnMQ4wDAYDVQQRDAUyMjMwNTEcMBoGA1UECQwTQnJhbWZlbGRlciBTdHIuIDE0MD
EpMCcGA1UECgwgVGVjaG5pa2VyIEtyYW5rZW5rYXNzZSBOT1QtVkFMSUQxIDAeBgNVBAUTFzEyLjg
wMjc2MDAzNDQxMjAwMDc1MDg1MSkwJwYDVQQDDCBUZWNobmlrZXIgS3Jhbmtlbmthc3NlIFRFU1Qt
T05MWTBaMBQGByqGSM49AgEGCSskAwMCCAEBBwNCAASJVInVJ+T7m9Cb15TnGktiMH0S7u2hySspy
3JDMp4IqEx0CtwRxlVdXQDAga+Cpy4p445yDtRKdM61ZHO14Mt3o4IBSDCCAUQwHQYDVR0OBBYEFK
PYQvWf9gVo9c1pHtbrTkMDdat5MA4GA1UdDwEB/wQEAwIDCDAMBgNVHRMBAf8EAjAAMCAGA1UdIAQ
ZMBcwCgYIKoIUAEwEgSMwCQYHKoIUAEwETDBCBggrBgEFBQcBAQQ2MDQwMgYIKwYBBQUHMAGGJmh0
dHA6Ly9vY3NwLnNtY2IudGVzdC50ZWxlc2VjLmRlL29jc3ByMB8GA1UdIwQYMBaAFDOvpKthm/Vi6
OIprNaG66+yVXttMH4GBSskCAMDBHUwc6QsMCoxCzAJBgNVBAYTAkRFMRswGQYDVQQKDBJTTS1CIE
tUUiBTdWJkb21haW4wQzBBMD8wPTAfDB1CZXRyaWVic3N0w6R0dGUgS29zdGVudHLDpGdlcjAJBgc
qghQATAQ7Ew84LTAxLTAwMDAwMDAwOTAwCgYIKoZIzj0EAwIDRwAwRAIgb0N3jrN1ylNYC8hlb26l
8EGsw0Vv5Ne5T1FR1JRIloYCIEpvsMlUGxVwGMj+fh/9blAcpWcNga8RhcbvjPLp80PY
personalEntry: false
title: -
KOM-LE-Version: 1.0
domainID: 101577501
entryType: 5
telematikID: 8-01-0000000090
dataFromAuthority: TRUE
countryCode: DE
street: Bramfelder Str. 140
holder: dtsg
professionOID: 1.2.276.0.76.4.59
komLeData: 1.0,tk-dt03@akquinet.kim.telematik-test
komLeData: 1.0,tk-intern@akquinet.kim.telematik-test
komLeData: 1.0,tk-dt01@akquinet.kim.telematik-test
komLeData: 1.0,tk-dt02@akquinet.kim.telematik-test
komLeData: 1.0,tk-dein@akquinet.kim.telematik-test
st: -
l: Hamburg
postalCode: 22305
changeDateTime: 2021-10-12T10:45:25.537594+02:00
uid: fc695fd6-b6e9-4754-9684-fee70f743086
# search result
search: 2
result: 0 Success
# numResponses: 2
# numEntries: 1
Im Attribut komLeData
steht die zu verwendende KIM-Adresse hier komLeData: 1.0,tk-dt03@akquinet.kim.telematik-test
.
Sollten zu dem ausgewählten Kostenträger mehrere Verzeichniseinträge hinterlegt sein (in der PU - Produktivumgebung - kann das aktuell jedoch nicht vorkommen), dann sollte geprüft werden, für welchen dieser Verzeichniseinträge eine KIM-Adresse hinterlegt ist. Sind mehrere KIM-Adressen hinterlegt - auch dieser Fall ist aktuell in der PU nicht vorgesehen, empfiehlt sich der Versand an die erste gefundene KIM-Adresse der jeweiligen Krankenkasse.
Kann kein Empfänger aus dem VZD der TI ermittelt werden, muss der Anwendungsfall mit einer Fehlermeldung abgebrochen werden, demzufolge die Empfängeradresse der Krankenkasse mit den bereitgestellten Informationen nicht ermittelt werden konnte. Ggfs. müssen die Angaben durch den Patienten konkretisiert werden, bei welcher Krankenkasse er versichert ist.
Hinweis
Im obigen Beispiel sind 5 KIM-Adressen im VZD-Eintrag enthalten. Gängige E-Mail-Clients mit LDAP-Integration verwenden die erste gefundene Adresse. Der VZD-Eintrag der Techniker Krankenkasse enthält in der Produktiv-Umgebung genau eine KIM-Adresse.
Details und weitere Hinweise zur Suche finden sich in der API-Beschreibung zum VZD.
Anforderung zur Ausstellung einer Ersatzbescheinigung via KIM
Liegen alle Informationen im PVS vor, werden diese in einer FHIR-Ressource EEBAnfrageBundle
zusammengestellt und als Anhang einer KIM-Nachricht an die Kasse gesendet.
Anfrage Header
Der für den genutzten Bundle-Typ message
verpflichtende Header transportiert neben Metainformationen (Leistungsdatum, Referenz auf die anfragende Praxis KBV_PR_FOR_Organization
) das Einverständnis des Patienten (true
= eingewilligt), das zuvor vom Praxispersonal eingeholt wurde.
Das Feld MessageHeader.source.endpoint
ist dabei ein vom FHIR-Standard vorgesehenes Pflichtfeld, das mit einer vom PVS gewählten URL belegt werden kann.
EEBAnfrageHeader (MessageHeader) | I | MessageHeader | There are no (further) constraints on this element Element idMessageHeader A resource that describes a message that is exchanged between systems DefinitionThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idMessageHeader.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idMessageHeader.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idMessageHeader.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idMessageHeader.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | Σ | 1..1 | canonical(StructureDefinition)Fixed Value | Element idMessageHeader.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
https://gematik.de/fhir/eeb/StructureDefinition/EEBAnfrageHeader |
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idMessageHeader.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idMessageHeader.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMessageHeader.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMessageHeader.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idMessageHeader.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idMessageHeader.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 3..* | Extension | Element idMessageHeader.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
Leistungsdatum | I | 1..1 | Extension(date) | Element idMessageHeader.extension:Leistungsdatum Datum der Leistungserbringung Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://gematik.de/fhir/eeb/StructureDefinition/Leistungsdatum Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.extension:Leistungsdatum.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idMessageHeader.extension:Leistungsdatum.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMessageHeader.extension:Leistungsdatum.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://gematik.de/fhir/eeb/StructureDefinition/Leistungsdatum
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idMessageHeader.extension:Leistungsdatum.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueDate | date | There are no (further) constraints on this element Data type | ||
Einverstaendnis | I | 1..1 | Extension(boolean) | Element idMessageHeader.extension:Einverstaendnis Einverständnis des Versicherten Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://gematik.de/fhir/eeb/StructureDefinition/Einverstaendnis Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.extension:Einverstaendnis.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idMessageHeader.extension:Einverstaendnis.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMessageHeader.extension:Einverstaendnis.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://gematik.de/fhir/eeb/StructureDefinition/Einverstaendnis
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idMessageHeader.extension:Einverstaendnis.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
Institutionskennzeichen | I | 1..1 | Extension(IdentifierIknr) | Element idMessageHeader.extension:Institutionskennzeichen Institutionskennzeichen der Krankenkasse Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://gematik.de/fhir/eeb/StructureDefinition/Institutionskennzeichen Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.extension:Institutionskennzeichen.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idMessageHeader.extension:Institutionskennzeichen.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMessageHeader.extension:Institutionskennzeichen.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://gematik.de/fhir/eeb/StructureDefinition/Institutionskennzeichen
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idMessageHeader.extension:Institutionskennzeichen.value[x] An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
| ||
valueIdentifier | IdentifierIknr | There are no (further) constraints on this element Data type | ||
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
event[x] | Σ | 1..1 | Binding | Element idMessageHeader.event[x] Code for the event this message represents or link to event definition DefinitionCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. Drives the behavior associated with this message. The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. One of the message events defined as part of this version of FHIR.
|
eventCoding | Coding | Data type | ||
destination | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idMessageHeader.destination Message destination application(s) DefinitionThe destination application which the message is intended for. Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient". There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
|
sender | Σ | 1..1 | Reference() | Element idMessageHeader.sender Real world sender of the message DefinitionIdentifies the sending system to allow the use of a trust relationship. Allows routing beyond just the application level. Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.sender.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.sender.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element idMessageHeader.sender.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idMessageHeader.sender.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idMessageHeader.sender.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..0 | string | There are no (further) constraints on this element Element idMessageHeader.sender.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
enterer | Σ | 0..0 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idMessageHeader.enterer The source of the data entry DefinitionThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
author | Σ | 0..0 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idMessageHeader.author The source of the decision DefinitionThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
source | Σ | 1..1 | BackboneElement | There are no (further) constraints on this element Element idMessageHeader.source Message source application DefinitionThe source application from which this message originated. Allows replies, supports audit.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.source.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.source.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.source.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
name | Σ | 0..0 | string | There are no (further) constraints on this element Element idMessageHeader.source.name Name of system DefinitionHuman-readable name for the source system. May be used to support audit.
|
software | Σ | 0..0 | string | There are no (further) constraints on this element Element idMessageHeader.source.software Name of software running the system DefinitionMay include configuration or other information useful in debugging. Supports audit and possibly interface engine behavior.
|
version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMessageHeader.source.version Version of software running DefinitionCan convey versions of multiple systems in situations where a message passes through multiple hands. Supports audit and possibly interface engine behavior.
|
contact | Σ | 0..0 | ContactPoint | There are no (further) constraints on this element Element idMessageHeader.source.contact Human contact for problems DefinitionAn e-mail, phone, website or other contact point to use to resolve issues with message communications. Allows escalation of technical issues.
|
endpoint | Σ | 1..1 | url | Element idMessageHeader.source.endpoint Source endpoint URI of sender. E.g. https://pvs.de/KIM DefinitionIdentifies the routing target to send acknowledgements to. Identifies where to send responses, may influence security permissions. The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
|
responsible | Σ | 0..0 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element idMessageHeader.responsible Final responsibility for event DefinitionThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
reason | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMessageHeader.reason Cause of event DefinitionCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization. Reason for event occurrence.
|
response | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idMessageHeader.response If this is a reply to prior message DefinitionInformation about the message that this message is a response to. Only present if this message is a response.
|
focus | Σ | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idMessageHeader.focus The actual content of the message DefinitionThe actual data of the message - a reference to the root/focus class of the event. Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources. The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.
|
definition | Σ | 0..0 | canonical(MessageDefinition) | There are no (further) constraints on this element Element idMessageHeader.definition Link to the definition for this message DefinitionPermanent link to the MessageDefinition for this message. Allows sender to define the expected contents of the message.
|
Anfrage Bundle
EEBAnfrageBundle (Bundle) | I | Bundle | Element idBundle Contains a collection of resources DefinitionA container for a collection of resources.
| |
id | Σ | 1..1 | string | There are no (further) constraints on this element Element idBundle.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idBundle.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idBundle.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | Σ | 1..1 | canonical(StructureDefinition)Fixed Value | Element idBundle.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
https://gematik.de/fhir/eeb/StructureDefinition/EEBAnfrageBundle |
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idBundle.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idBundle.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idBundle.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idBundle.identifier Persistent identifier for the bundle DefinitionA persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.
|
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idBundle.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idBundle.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | Σ | 1..1 | uriFixed Value | Element idBundle.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
urn:ietf:rfc:3986
|
value | Σ | 1..1 | string | Element idBundle.identifier.value Eindeutige UUID DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idBundle.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idBundle.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
type | Σ | 1..1 | codeBindingFixed Value | Element idBundle.type document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection DefinitionIndicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Indicates the purpose of a bundle - how it is intended to be used.
message
|
timestamp | Σ | 1..1 | instant | There are no (further) constraints on this element Element idBundle.timestamp When the bundle was assembled DefinitionThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage:
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.
|
total | Σ I | 0..0 | unsignedInt | There are no (further) constraints on this element Element idBundle.total If search, the total number of matches DefinitionIf a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.
|
link | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.link Links related to this Bundle DefinitionA series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.
|
entry | Σ I | 3..3 | BackboneElement | Element idBundle.entry Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). Unordered, Closed, by resource.meta.profile(Value) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry.link Links related to this entry DefinitionA series of links that provide context to this entry.
|
fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry.fullUrl URI for resource (Absolute URL server address or URI for UUID/OID) DefinitionThe Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
|
resource | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.resource A resource in the bundle DefinitionThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. |
search | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.search Search related information DefinitionInformation about the search process that lead to the creation of this entry.
|
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.search.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.search.mode match | include | outcome - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
|
score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry.search.score Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element.
|
request | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.request Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
|
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
method | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.request.method GET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. HTTP verbs (in the HTTP command line). See HTTP rfc for details.
|
url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry.request.url URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".
|
ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneMatch For managing cache currency DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".
|
ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.request.ifModifiedSince For managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read".
|
ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifMatch For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".
|
ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneExist For conditional creates DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").
|
response | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.response Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
|
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
status | Σ | 1..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.status Status response code (text optional) DefinitionThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.
|
location | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry.response.location The location (if the operation returns a location) DefinitionThe location header created by processing this operation, populated if the operation returns a location.
|
etag | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.etag The Etag for the resource (if relevant) DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
|
lastModified | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.response.lastModified Server's date time modified DefinitionThe date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
|
outcome | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.response.outcome OperationOutcome with hints and warnings (for batch/transaction) DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. |
EEBAnfrageHeader | Σ I | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBAnfrageHeader Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
|
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:EEBAnfrageHeader.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:EEBAnfrageHeader.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:EEBAnfrageHeader.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:EEBAnfrageHeader.link Links related to this entry DefinitionA series of links that provide context to this entry.
|
fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:EEBAnfrageHeader.fullUrl URI for resource (Absolute URL server address or URI for UUID/OID) DefinitionThe Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
|
resource | I | 1..1 | EEBAnfrageHeader | Element idBundle.entry:EEBAnfrageHeader.resource A resource that describes a message that is exchanged between systems DefinitionThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
|
search | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBAnfrageHeader.search Search related information DefinitionInformation about the search process that lead to the creation of this entry.
|
request | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBAnfrageHeader.request Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
|
response | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBAnfrageHeader.response Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
|
EEBKnownPatient | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBKnownPatient Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
|
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:EEBKnownPatient.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:EEBKnownPatient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:EEBKnownPatient.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:EEBKnownPatient.link Links related to this entry DefinitionA series of links that provide context to this entry.
|
fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:EEBKnownPatient.fullUrl URI for resource (Absolute URL server address or URI for UUID/OID) DefinitionThe Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
|
resource | I | 1..1 | EEBKnownPatient | Element idBundle.entry:EEBKnownPatient.resource Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
|
search | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBKnownPatient.search Search related information DefinitionInformation about the search process that lead to the creation of this entry.
|
request | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBKnownPatient.request Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
|
response | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBKnownPatient.response Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
|
KBV_PR_FOR_Patient | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Patient Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
|
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Patient.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Patient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Patient.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Patient.link Links related to this entry DefinitionA series of links that provide context to this entry.
|
fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Patient.fullUrl URI for resource (Absolute URL server address or URI for UUID/OID) DefinitionThe Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
|
resource | Σ I | 1..1 | Element idBundle.entry:KBV_PR_FOR_Patient.resource Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDieses Element beschreibt eine Person, die eine oder mehrere medizinische Leistungen in Anspruch nimmt.
| |
search | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Patient.search Search related information DefinitionInformation about the search process that lead to the creation of this entry.
|
request | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Patient.request Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
|
response | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Patient.response Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
|
KBV_PR_FOR_Organization | Σ I | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Organization Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
|
id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Organization.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Organization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Organization.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Organization.link Links related to this entry DefinitionA series of links that provide context to this entry.
|
fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Organization.fullUrl URI for resource (Absolute URL server address or URI for UUID/OID) DefinitionThe Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
|
resource | I | 1..1 | Element idBundle.entry:KBV_PR_FOR_Organization.resource A grouping of people or organizations with a common purpose DefinitionDie Einrichtung beschreibt beispielsweise den Ort, an dem ein Kontakt zwischen der zu behandelnden Person und der leistungserbringenden Person stattfindet (z.B. Praxis). Diese kann aber auch eine rein 'fiktive' Organisation zur Abrechnung sein (z.B. IK-Organisation für Hebammen).
| |
search | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Organization.search Search related information DefinitionInformation about the search process that lead to the creation of this entry.
|
request | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Organization.request Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
|
response | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBV_PR_FOR_Organization.response Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
|
signature | Σ | 0..0 | Signature | There are no (further) constraints on this element Element idBundle.signature Digital Signature DefinitionDigital Signature - base64 encoded. XML-DSig or a JWT. A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.
|
Im folgenden Link ist ein Beispiel-Bundle Patient mit bekannter KVNR dargestellt.
Ausgestaltung der Bescheinigung
EEB-Anfragen über KIM werden nach erfolgreicher Prüfung von der Kasse mit den Coverage Profilen EEBCovergaEgkNoAddressLine bzw. EEBCoverageNoEgk abhängig beantwortet, ob der angefragte Patient eine KNVR hat oder nicht.
KVNR für Patient vorhanden
Ist die KVNR für den angefragten Patienten vorhanden, so wird in der EEBBescheinigung für die Coverage das Profil EEBCoverageEgkNoAddressLine
und für den Patienten das Profil KBV_PR_FOR_Patient
verwendet.
- Im VSD-Container
persoenlicheVersicherungsdaten
des Profils EEBCoverageNoAddressLine werden in der Straßenadresse die Werte für Straße und Hausnummer nicht gesetzt. - Im VSD-Container
allgemeineVersicherungsdaten
ist der Versicherungsbeginn ein muss-Feld. Daher wird ein fiktiver Versicherungsbeginn konstant auf 01.01.1900 gesetzt. Dieses Datum repräsentiert nicht den wahren Versicherungsbeginn des Versicherten und darf für weitere Geschäftsfunktionen, z.B. Abrechnungsmodalitäten, nicht verwendet werden. - Im Profil
KBV_PR_FOR_Patient
wird das Feldaddress.line
inklusive der extensions der Straßenanschrift weggelassen, damit entfallen zusätzlich die Felder Strasse, Hausnummer und Adresszusatz.
KVNR für Patient nicht vorhanden
Besitzt der Patient noch keine KVNR (z.B. Neugeborene) sowie wird das Coverage Profil EEBCoverageNoEgk
verwendet. In diesem Profil gibt es weder einen Versicherungsbeginn noch eine Straßenadresse, so dass sich die geforderten Adresseinschränkungen nur im Profil KBV_PR_FOR_Patient
auswirken. D.h. auch in dieser Konstellation (EEBCoverageNoEgk
) werden im Profil KBV_PR_FOR_Patient
das Feld line der Straßenanschrift weggelassen.