IG TTP-FHIR Gateway

IsConsented

Voraussetzung

Spezifizierte Domäne muss angelegt sein
Es muss eine gültige Einwilligung mit dem gegebenen personIdentifier existieren
Die spezifizierte Policy muss innerhalb einer gültigen Einwilligung des Patienten referenziert werden
Bei Nutzung alternativer PolicyCodeSysteme müssen nötige fhirPolicyCodes innerhalb von gICS per ExternalProperty der Policies definiert worden sein (Beispiel)

Aufruf und Rückgabe

Invocations

URL: [base]/$isConsented

This operation does NOT change content

Parameters (In)

Name	Cardinality	Type	Binding	Documentation
personIdentifier	1..*	Identifier		Um den Bezug zwischen Person und Einwilligung herzustellen, ist die Angabe von mindestens einem eindeutigen Personenidentifikator erforderlich. Dies kann je nach Anforderungen die Fallnummer, ein Patienten-Identifikator, die Angabe eines Bevollmächtigten oder ein Studienpseudonym, o.ä. sein und erfolgt unter Verwendung des passenden Patienten-Profils der AG Einwilligungsmanagement: https://simplifier.net/guide/Einwilligungsmanagement/Patient. Bei Angabe von mehreren Identifikatoren werden diese ODER-verknüpft.
domain	1..1	string		Angabe der Einwilligungsdomaene
policy	1..1	Coding	Policy (extensible)
version	1..1	string
config	0..1	Parameters

Return Values (Out)

Name	Cardinality	Type	Documentation
consented	1..1	boolean

Liefert den Einwilligungsstatus eines Patienten für eine spezifische Policy per POST-Request. Die Rückgabe erfolgt als Parameters-Ressource.

Der Parameter config enthält eine verschachtelte Parameters-Ressource entsprechend dem Config-Profil:

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
parameter	Σ I	1..4	BackboneElement	Element Id Parameters.parameter Short description Operation Parameter Definition A parameter passed to or received from the operation. Data Type BackboneElement Sliced: Unordered, Closed, by name(Value) 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()))` Mappings rim:n/a
(All Slices)				There are no (further) constraints on this element
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). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
value[x]	Σ I	0..1		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())` Mappings rim:n/a
valueBase64Binary			base64Binary	There are no (further) constraints on this element Data Type base64Binary
valueBoolean			boolean	There are no (further) constraints on this element Data Type boolean
valueCanonical			canonical()	There are no (further) constraints on this element Data Type canonical()
valueCode			code	There are no (further) constraints on this element Data Type code
valueDate			date	There are no (further) constraints on this element Data Type date
valueDateTime			dateTime	There are no (further) constraints on this element Data Type dateTime
valueDecimal			decimal	There are no (further) constraints on this element Data Type decimal
valueId			id	There are no (further) constraints on this element Data Type id
valueInstant			instant	There are no (further) constraints on this element Data Type instant
valueInteger			integer	There are no (further) constraints on this element Data Type integer
valueMarkdown			markdown	There are no (further) constraints on this element Data Type markdown
valueOid			oid	There are no (further) constraints on this element Data Type oid
valuePositiveInt			positiveInt	There are no (further) constraints on this element Data Type positiveInt
valueString			string	There are no (further) constraints on this element Data Type string
valueTime			time	There are no (further) constraints on this element Data Type time
valueUnsignedInt			unsignedInt	There are no (further) constraints on this element Data Type unsignedInt
valueUri			uri	There are no (further) constraints on this element Data Type uri
valueUrl			url	There are no (further) constraints on this element Data Type url
valueUuid			uuid	There are no (further) constraints on this element Data Type uuid
valueAddress			Address	There are no (further) constraints on this element Data Type Address
valueAge			Age	There are no (further) constraints on this element Data Type Age
valueAnnotation			Annotation	There are no (further) constraints on this element Data Type Annotation
valueAttachment			Attachment	There are no (further) constraints on this element Data Type Attachment
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
valueCoding			Coding	There are no (further) constraints on this element Data Type Coding
valueContactPoint			ContactPoint	There are no (further) constraints on this element Data Type ContactPoint
valueCount			Count	There are no (further) constraints on this element Data Type Count
valueDistance			Distance	There are no (further) constraints on this element Data Type Distance
valueDuration			Duration	There are no (further) constraints on this element Data Type Duration
valueHumanName			HumanName	There are no (further) constraints on this element Data Type HumanName
valueIdentifier			Identifier	There are no (further) constraints on this element Data Type Identifier
valueMoney			Money	There are no (further) constraints on this element Data Type Money
valuePeriod			Period	There are no (further) constraints on this element Data Type Period
valueQuantity			Quantity	There are no (further) constraints on this element Data Type Quantity
valueRange			Range	There are no (further) constraints on this element Data Type Range
valueRatio			Ratio	There are no (further) constraints on this element Data Type Ratio
valueSampledData			SampledData	There are no (further) constraints on this element Data Type SampledData
valueSignature			Signature	There are no (further) constraints on this element Data Type Signature
valueTiming			Timing	There are no (further) constraints on this element Data Type Timing
valueContactDetail			ContactDetail	There are no (further) constraints on this element Data Type ContactDetail
valueContributor			Contributor	There are no (further) constraints on this element Data Type Contributor
valueDataRequirement			DataRequirement	There are no (further) constraints on this element Data Type DataRequirement
valueExpression			Expression	There are no (further) constraints on this element Data Type Expression
valueParameterDefinition			ParameterDefinition	There are no (further) constraints on this element Data Type ParameterDefinition
valueRelatedArtifact			RelatedArtifact	There are no (further) constraints on this element Data Type RelatedArtifact
valueTriggerDefinition			TriggerDefinition	There are no (further) constraints on this element Data Type TriggerDefinition
valueUsageContext			UsageContext	There are no (further) constraints on this element Data Type UsageContext
valueDosage			Dosage	There are no (further) constraints on this element Data Type Dosage
valueMeta			Meta	There are no (further) constraints on this element Data Type Meta
valueReference			Reference()	There are no (further) constraints on this element Data Type Reference()
resource	Σ I	0..1	Resource	There are no (further) constraints on this element Element Id Parameters.parameter.resource Short description If parameter is a whole resource Definition If the parameter is a whole resource. 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 Resource Mappings rim:Entity. Role, or Act
part	Σ	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.
idMatchingType	Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Parameters.parameter:idMatchingType 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()))` Mappings rim:n/a
name	Σ	1..1	stringFixed Value	Element Id Parameters.parameter:idMatchingType.name Short description Name from the definition Definition The name of the parameter (reference to the operation definition). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value idMatchingType Mappings rim:n/a
value[x]	Σ I	1..1	Binding	Element Id Parameters.parameter:idMatchingType.value[x] Short description If parameter is a data type Definition If the parameter is a data type. Binding IdMatchingType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
valueCoding			Coding	Data Type Coding
system	Σ	1..1	uri	There are no (further) constraints on this element Element Id Parameters.parameter:idMatchingType.value[x].system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.3 rim:./codeSystem orim:*fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element Id Parameters.parameter:idMatchingType.value[x].version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.7 rim:./codeSystemVersion orim:*fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	1..1	code	There are no (further) constraints on this element Element Id Parameters.parameter:idMatchingType.value[x].code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.1 rim:./code orim:*fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Parameters.parameter:idMatchingType.value[x].display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.2 - but note this is not well followed rim:CV.displayName orim:*fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element Id Parameters.parameter:idMatchingType.value[x].userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:Sometimes implied by being first rim:CD.codingRationale orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
resource	Σ I	0..0	Resource	There are no (further) constraints on this element Element Id Parameters.parameter:idMatchingType.resource Short description If parameter is a whole resource Definition If the parameter is a whole resource. 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 Resource Mappings rim:Entity. Role, or Act
part	Σ	0..0	see (parameter)	There are no (further) constraints on this element Element Id Parameters.parameter:idMatchingType.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.
ignoreVersionNumber	Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Parameters.parameter:ignoreVersionNumber 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()))` Mappings rim:n/a
name	Σ	1..1	stringFixed Value	Element Id Parameters.parameter:ignoreVersionNumber.name Short description Name from the definition Definition The name of the parameter (reference to the operation definition). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value ignoreVersionNumber Mappings rim:n/a
value[x]	Σ I	1..1		There are no (further) constraints on this element Element Id Parameters.parameter:ignoreVersionNumber.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())` Mappings rim:n/a
valueBoolean			boolean	Data Type boolean
resource	Σ I	0..0	Resource	There are no (further) constraints on this element Element Id Parameters.parameter:ignoreVersionNumber.resource Short description If parameter is a whole resource Definition If the parameter is a whole resource. 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 Resource Mappings rim:Entity. Role, or Act
part	Σ	0..0	see (parameter)	There are no (further) constraints on this element Element Id Parameters.parameter:ignoreVersionNumber.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.
unknownStateIsConsideredAsDecline	Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Parameters.parameter:unknownStateIsConsideredAsDecline 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()))` Mappings rim:n/a
name	Σ	1..1	stringFixed Value	Element Id Parameters.parameter:unknownStateIsConsideredAsDecline.name Short description Name from the definition Definition The name of the parameter (reference to the operation definition). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value unknownStateIsConsideredAsDecline Mappings rim:n/a
value[x]	Σ I	1..1		There are no (further) constraints on this element Element Id Parameters.parameter:unknownStateIsConsideredAsDecline.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())` Mappings rim:n/a
valueBoolean			boolean	Data Type boolean
resource	Σ I	0..0	Resource	There are no (further) constraints on this element Element Id Parameters.parameter:unknownStateIsConsideredAsDecline.resource Short description If parameter is a whole resource Definition If the parameter is a whole resource. 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 Resource Mappings rim:Entity. Role, or Act
part	Σ	0..0	see (parameter)	There are no (further) constraints on this element Element Id Parameters.parameter:unknownStateIsConsideredAsDecline.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.
requestDate	Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Parameters.parameter:requestDate 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()))` Mappings rim:n/a
name	Σ	1..1	stringFixed Value	Element Id Parameters.parameter:requestDate.name Short description Name from the definition Definition The name of the parameter (reference to the operation definition). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value requestDate Mappings rim:n/a
value[x]	Σ I	1..1		There are no (further) constraints on this element Element Id Parameters.parameter:requestDate.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())` Mappings rim:n/a
valueDate			date	Data Type date
resource	Σ I	0..0	Resource	There are no (further) constraints on this element Element Id Parameters.parameter:requestDate.resource Short description If parameter is a whole resource Definition If the parameter is a whole resource. 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 Resource Mappings rim:Entity. Role, or Act
part	Σ	0..0	see (parameter)	There are no (further) constraints on this element Element Id Parameters.parameter:requestDate.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.

Beispiel

Beispiel für einen Request auf Basis des Codesystems Policy:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="IsConsented-request-example-1" />
    <parameter>
        <name value="personIdentifier" />
        <valueIdentifier>
            <system value="https://ths-greifswald.de/fhir/gics/identifiers/Pseudonym" />
            <value value="dic_1H51T" />
        </valueIdentifier>
    </parameter>
    <parameter>
        <name value="domain" />
        <valueString value="num" />
    </parameter>
    <parameter>
        <name value="policy" />
        <valueCoding>
            <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" />
            <code value="MDAT_erheben" />
        </valueCoding>
    </parameter>
    <parameter>
        <name value="version" />
        <valueString value="1.1" />
    </parameter>
    <parameter>
        <name value="config" />
        <resource>
            <Parameters>
                <parameter>
                    <name value="idMatchingType" />
                    <valueCoding>
                        <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/IdMatchingType" />
                        <code value="AT_LEAST_ONE" />
                    </valueCoding>
                </parameter>
                <parameter>
                    <name value="ignoreVersionNumber" />
                    <valueBoolean value="false" />
                </parameter>
                <parameter>
                    <name value="unknownStateIsConsideredAsDecline" />
                    <valueBoolean value="false" />
                </parameter>
                <parameter>
                    <name value="requestDate" />
                    <valueDate value="2019-06-30" />
                </parameter>
            </Parameters>
        </resource>
    </parameter>
</Parameters>

Beispiel für einen Request mit alternativem Codesystem:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="IsConsented-request-example-2" />
    <parameter>
        <name value="personIdentifier" />
        <valueIdentifier>
            <system value="https://ths-greifswald.de/fhir/gics/identifiers/Pseudonym" />
            <value value="dic_1H51T" />
        </valueIdentifier>
    </parameter>
    <parameter>
        <name value="domain" />
        <valueString value="num" />
    </parameter>
    <parameter>
        <name value="policy" />
        <valueCoding>
            <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" />
            <code value="2.16.840.1.113883.3.1937.777.24.5.3.6" />
        </valueCoding>
    </parameter>
    <parameter>
        <name value="version" />
        <valueString value="1.1" />
    </parameter>
</Parameters>

Eine beispielhafte Rückmeldung kann wie folgt aussehen:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="IsConsented-response-example-1" />
    <parameter>
        <name value="consented" />
        <valueBoolean value="true" />
    </parameter>
</Parameters>

Error Codes

Beschreibung	HTTP Error Code
Fehlende Parameter	400 Bad Request
Parameter mit unbekanntem Inhalt	404 Not found
Leere Ergebnismenge trotz gültiger Parameter	200 Ok