getAllConsentedIdsFor

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(gics client definable configuration Config)

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:

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)

Beispiel

Beispielhafter Request-Body:

The resource cannot be rendered.

Beispielhafte Rückmeldung:

<Parameters xmlns="http://hl7.org/fhir">
    <parameter>
        <name value="personIdentifier" />
        <valueIdentifier>
            <system value="https://ths-greifswald.de/fhir/gics/identifiers/Pseudonym" />
            <value value="dic_1H51T" />
        </valueIdentifier>
    </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