GetAllConsentedIdsFor

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 personIdentifierType existieren
  • Die spezifizierte Policy muss innerhalb einer gültigen Einwilligung 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]/$getAllConsentedIdsFor

This operation does NOT change content

Parameters (In)

NameCardinalityTypeBindingDocumentation
domain1..1string

Angabe der Einwilligungsdomaene

signerIdTypeName1..1string

Angabe des Signer-ID-Typs

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

Version der Policy

config0..1Parameters

Return Values (Out)

NameCardinalityTypeDocumentation
personIdentifier0..*Identifier

Abruf aller Identifier eines bestimmten benannten Identifier-Typs (z.b. studyPsn) für eine bestimmte Policy (Coding) und Domäne. Zurück geliefert wird eine Liste von eingewilligten Identifiern in Bezug auf die spezifizierte Policy.

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

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
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)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringFixed Value
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
resourceΣ I0..0Resource
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringFixed Value
valueBooleanboolean
resourceΣ I0..0Resource
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringFixed Value
valueBooleanboolean
resourceΣ I0..0Resource
partΣ0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
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

Beispielhafter Request-Body:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="GetAllConsentedIdsFor-request-example-1" />
    <parameter>
        <name value="signerIdTypeName" />
        <valueString value="Pseudonym" />
    </parameter>
    <parameter>
        <name value="domain" />
        <valueString value="MII" />
    </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="EXACT" />
                    </valueCoding>
                </parameter>
                <parameter>
                    <name value="ignoreVersionNumber" />
                    <valueBoolean value="false" />
                </parameter>
                <parameter>
                    <name value="unknownStateIsConsideredAsDecline" />
                    <valueBoolean value="false" />
                </parameter>
                <parameter>
                    <name value="requestDate" />
                    <valueDate value="2021-06-18" />
                </parameter>
            </Parameters>
        </resource>
    </parameter>
</Parameters>

Beispielhafte Rückmeldung:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="GetAllConsentedIdsFor-response-example-1" />
    <parameter>
        <name value="personIdentifier" />
        <valueIdentifier>
            <system value="https://ths-greifswald.de/fhir/gics/identifiers/Pseudonym" />
            <value value="dic_1H51T" />
        </valueIdentifier>
    </parameter>
</Parameters>