Implementierungsleitfaden für DEMIS Common (Basismeldeinhalte)

ProcessNotificationRequestParameters

https://demis.rki.de/fhir/StructureDefinition/ProcessNotificationRequestParameters

Der ProcessNotificationRequestParameter ist der Eingabeparameter für die ProcessNotification-Operation. Er enthält den Meldevorgang der an DEMIS übermittelt wird.

Hinweis: In der Vergangenheit gab es Fehler bei der Validierung des ProcessNotificationRequestParameters. Das grundsätzliche Problem sind FHIR-R4-Constraints auf Wurzelelementen von Ressourcen, die die eingebaute Variable %resource benutzen und in andere Ressourcen eingebettet werden. Das betrifft insbesondere die beiden Constraints bdl-3 und bdl-4 in der FHIR-R4-Bundle-Ressource. In R5 wurden diese beiden Constraints entfernt und dafür die Constraints bdl-3a bis bdl-3d eingeführt, siehe R5. Wir gehen davon aus, dass die R4-Bundle-Constraints bdl-3 und bdl-4 problematisch sind und deren Ergebnisse herausgefiltert werden können, daher haben wir als Bestandteil des Snapshot-Baus diese automatisch entfernt. Diese technische Anpassung hat inhaltlich keinen Einfluss auf das ProcessNotificationRequestParameters-Profil.

ProcessNotificationRequestParameters (Parameters)			Parameters	There are no (further) constraints on this element Element id Parameters Short description Operation Request or Response Definition This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. Comments The parameters that may be used are defined by the OperationDefinition resource. Data type Parameters Mappings rim: Entity. Role, or Act v2: n/a rim: n/a
id	Σ	0..1	string	There are no (further) constraints on this element Element id Parameters.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	S Σ	1..1	Meta	There are no (further) constraints on this element Element id Parameters.meta Short description Metadata about the resource Definition The 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id Parameters.meta.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Parameters.meta.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
versionId	Σ	0..1	id	There are no (further) constraints on this element Element id Parameters.meta.versionId Short description Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. Comments 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. Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
lastUpdated	Σ	0..1	instant	There are no (further) constraints on this element Element id Parameters.meta.lastUpdated Short description When the resource version last changed Definition When the resource last changed - e.g. when the version changed. Comments 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. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
source	Σ	0..1	uri	There are no (further) constraints on this element Element id Parameters.meta.source Short description Identifies where the resource comes from Definition A 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. Comments 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
profile	S Σ	1..1	canonical(StructureDefinition)Pattern	Element id Parameters.meta.profile Short description Profiles this resource claims to conform to Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. Comments 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. Data type canonical(StructureDefinition) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern https://demis.rki.de/fhir/StructureDefinition/ProcessNotificationRequestParameters
security	Σ	0..*	CodingBinding	There are no (further) constraints on this element Element id Parameters.meta.security Short description Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. Comments 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. Data type Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
tag	Σ	0..*	Coding	There are no (further) constraints on this element Element id Parameters.meta.tag Short description Tags applied to this resource Definition Tags 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. Comments 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. Data type Coding Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Parameters.implicitRules Short description A set of rules under which this content was created Definition A 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. Comments 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Parameters.language Short description Language of the resource content Definition The base language in which the resource is written. Comments 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
parameter	S Σ I	1..1	BackboneElement	There are no (further) constraints on this element Element id Parameters.parameter Short description Operation Parameter Definition A parameter passed to or received from the operation. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` inv-1: A parameter must have one and only one of (value, resource, part) `(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))`
id		0..1	string	There are no (further) constraints on this element Element id Parameters.parameter.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Parameters.parameter.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. Comments 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Parameters.parameter.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May 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). Requirements 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. Comments 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
name	Σ	1..1	string	There are no (further) constraints on this element Element id Parameters.parameter.name Short description Name from the definition Definition The name of the parameter (reference to the operation definition). Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
value[x]	Σ I	0..0		There are no (further) constraints on this element Element id Parameters.parameter.value[x] Short description If parameter is a data type Definition If the parameter is a data type. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
resource	S I	1..1	NotificationBundle	Element id Parameters.parameter.resource Short description Meldevorgang Definition Meldevorgang der an DEMIS übermittelt wird. Comments When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. Data type NotificationBundle Constraints bdl-1: total only when a search or history `total.empty() or (type = 'searchset') or (type = 'history')` bdl-2: entry.search only when a search `entry.search.empty() or (type = 'searchset')` bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))` bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))` bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()` bdl-9: A document must have an identifier with a system and a value `type = 'document' implies (identifier.system.exists() and identifier.value.exists())` bdl-10: A document must have a date `type = 'document' implies (timestamp.hasValue())` bdl-11: A document must have a Composition as the first resource `type = 'document' implies entry.first().resource.is(Composition)` bdl-12: A message must have a MessageHeader as the first resource `type = 'message' implies entry.first().resource.is(MessageHeader)` atLeastOneMetaProfile: Es muss mindestens ein meta.profile angegeben werden. `entry.all(resource.meta.profile.count()>=1)` Mappings rim: Entity. Role, or Act v2: N/A rim: N/A cda: ClinicalDocument, if bundle.type = document
part	Σ	0..0	see (parameter)	There are no (further) constraints on this element Element id Parameters.parameter.part Short description Named part of a multi-part parameter Definition A named part of a multi-part parameter. Comments Only one level of nested parameters is allowed. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

Beispiel:

<Parameters xmlns="http://hl7.org/fhir">
  <id value="ProcessNotificationRequestParameters-example" />
  <meta>
    <profile value="https://demis.rki.de/fhir/StructureDefinition/ProcessNotificationRequestParameters" />
  </meta>
  <parameter>
    <name value="content" />
    <resource>
		<Bundle xmlns="http://hl7.org/fhir">
			...
		</Bundle>
	</resource>
  </parameter>
</Parameters>