IsConsented

Unterstützt ab TTP-FHIR Gateway Version 2.0.0

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)

NameCardinalityTypeBindingDocumentation
personIdentifier1..*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.

domain1..1string

Angabe der Einwilligungsdomaene

policy1..1CodingPolicy (extensible)
version1..1string
config0..1Parameters

Return Values (Out)

NameCardinalityTypeDocumentation
consented1..1boolean

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:

nameΣ1..1string
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
resourceΣ I0..1Resource
partΣ0..*see (parameter)
nameΣ1..1stringFixed Value
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
resourceΣ I0..0Resource
partΣ0..0see (parameter)
nameΣ1..1stringFixed Value
valueBooleanboolean
resourceΣ I0..0Resource
partΣ0..0see (parameter)
nameΣ1..1stringFixed Value
valueBooleanboolean
resourceΣ I0..0Resource
partΣ0..0see (parameter)
nameΣ1..1stringFixed Value
valueDatedate
resourceΣ I0..0Resource
partΣ0..0see (parameter)

Im Erfolgsfall wird der HTTP Statuscode 200 zurückgegeben.

Im Fehlerfall wird einer der folgenden HTTP Statuscodes in Verbindung mit einer OperationOutcome-Ressource zurückgegeben:

  • 400: Fehlende oder fehlerhafte Parameter.
  • 401: Fehlende Authentifizierung oder Autorisierung.
  • 422: Fehlende oder falsche Patienten-Attribute.
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>