Scalable Consent Management
1.0.0-preview - STU 1 PReview United States of America flag

Scalable Consent Management, published by HL7 International / Community Based Collaborative Care. This guide is not an authorized publication; it is the continuous build for version 1.0.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-consent-management/ and changes regularly. See the Directory of published versions

Requirements: Structure Definitions Client

Official URL: http://hl7.org/fhir/us/consent-management/Requirements/structure-definitions-client Version: 1.0.0-preview
Standards status: Trial-use Maturity Level: 1 Computable Name: StructureDefinitionsClient

Structure Definitions Requirements for Client

Requirements Actor(s)

These requirements apply to the following actors:

  • Client An application or product that implements the Client.

Requirements Statement List

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTConsent.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-FASTSubscription.html

Conformance: SHALL

Parent: Requirements-structure-definitions-client-consent-server.html#requirement-477

Notes: Since the client is the data source, they must be able to populate all filter criteria, as well as combinations.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/en/StructureDefinition-RevokeConsentParameters.html

Conformance: SHALL

Specification: Subscriptions R5 Backport

Link to Text: https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription-definitions.html

Conformance: SHALL

Parent: Requirements-subscription-topics-client-consent-server.html#requirement-596

Notes: Basing this on the definition in the topic and the fact that it is Must Support


Language: en

These requirements apply to the actor Client

requirement-829SHALL

FASTConsent must support extension:manager

Links:

requirement-830SHALL

FASTConsent must support extension:controller

Links:

requirement-1171SHALL

FASTConsent must support performer

Links:

requirement-831SHALL

FASTConsent must support policy

Links:

requirement-832SHALL

FASTConsent must support provision.actor

Links:

requirement-833SHALL

FASTConsent must support provision.purpose

Links:

requirement-834SHALL

FASTConsent must support provision.provision

Links:

requirement-1031SHALL

Consent Client SHALL support Consent read

Links:

requirement-1025SHALL

Consent Client SHALL support Consent search by _id

Links:

requirement-1027SHALL

Consent Client SHALL support Consent search by identifier

Links:

requirement-1029SHALL

Consent Client SHALL support Consent search by patient

Links:

requirement-1033SHALL

Consent Client SHALL support Consent search by the combination of the patient and status search parameters

Links:

requirement-1035SHOULD

Consent Client SHOULD support Consent search by the combination of the patient and date search parameters

Links:

requirement-835SHALL

FASTConsentAuditEvent must support outcomeDesc

Links:

requirement-836SHALL

FASTConsentAuditEvent must support purposeOfEvent

Links:

requirement-837SHALL

FASTConsentAuditEvent must support agent:client.policy

Links:

requirement-838SHALL

FASTConsentAuditEvent must support agent:user.role

Links:

requirement-839SHALL

FASTConsentAuditEvent must support agent:user.name

Links:

requirement-840SHALL

FASTConsentAuditEvent must support agent:user.policy

Links:

requirement-841SHALL

FASTConsentAuditEvent must support agent:user.purposeOfUse

Links:

requirement-842SHALL

FASTConsentAuditEvent must support agent:userorg.purposeOfUse

Links:

requirement-859SHALL

FASTDocumentReference must support identifier

Links:

requirement-860SHALL

FASTDocumentReference must support date

Links:

requirement-861SHALL

FASTDocumentReference must support author

Links:

requirement-862SHALL

FASTDocumentReference must support author as a US Core Practitioner

Links:

requirement-863SHALL

FASTDocumentReference must support content.attachment.contentType

Links:

requirement-864SHALL

FASTDocumentReference must support content.attachment.data

Links:

requirement-865SHALL

FASTDocumentReference must support content.attachment.url

Links:

requirement-866SHALL

FASTDocumentReference must support content.format

Links:

requirement-867SHALL

FASTDocumentReference must support context

Links:

requirement-868SHALL

FASTDocumentReference must support context.encounter

Links:

requirement-869SHALL

FASTDocumentReference must support context.period

Links:

requirement-870SHALL

FASTSubscription must support extension:filterCriteria<br/><br/>Since the client is the data source, they must be able to populate all filter criteria, as well as combinations.

Links:

requirement-871SHALL

FASTSubscription must support extension:customChannelType

Links:

requirement-872SHALL

FASTReference must support extension:additionalIdentifier

Links:

requirement-1172SHALL

RevokeConsentParameters must support parameter:document

Links:

requirement-640SHALL

Consent Client SHALL support Consent notification filter combinations, and they combine as AND<br/><br/>Basing this on the definition in the topic and the fact that it is Must Support

Links: