HL7 FHIR Implementation Guide Dossier Farmaceutico
0.1.1 - ci-build Italy flag

HL7 FHIR Implementation Guide Dossier Farmaceutico, published by HL7 Italia. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-it/dossier-pharma/ and changes regularly. See the Directory of published versions

CapabilityStatement: Dossier Farmaceutico - Consumer (client)

Official URL: http://hl7.it/fhir/dossier-pharma/CapabilityStatement/CapabilityStatementConsumerDossierPharmaIt Version: 0.1.1
Draft as of 2021-12-13 Computable Name: DossierFarmaceutico_Consumer

CapabilityStatement per il Consumer definito nelle specifiche del Dossier Farmaceutico

Raw OpenAPI-Swagger Definition file | Download

Dossier Farmaceutico - Consumer (client)

  • Implementation Guide Version: 0.1.1
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json, application/fhir+xml
  • Supported Patch Formats:
  • Published on: 2021-12-13
  • Published by: HL7 Italia

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

Summary of System-wide Interactions
  • Supports the search-systeminteraction.
  • Supports the history-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
MedicationDispensehttp://hl7.it/fhir/dossier-pharma/StructureDefinition/MedicationDispense-it-dossierPharmayysubject, whenhandedover, code
MedicationRequesthttp://hl7.it/fhir/dossier-pharma/StructureDefinition/MedicationRequest-it-dossierPharmayysubject, authoredon, code
Provenancehttp://hl7.it/fhir/dossier-pharma/StructureDefinition/Provenance-it-dossierPharmayytarget, entity
PractitionerRolehttp://hl7.it/fhir/dossier-pharma/StructureDefinition/PractitionerRole-prescrittore-it-dossierPharmayyidentifier
Locationhttp://hl7.it/fhir/dossier-pharma/StructureDefinition/Location-it-dossierPharmayyidentifier
Medicationhttp://hl7.it/fhir/dossier-pharma/StructureDefinition/Medication-it-dossierPharmayyidentifier, code
Patienthttp://hl7.it/fhir/StructureDefinition/Patient-it-baseyybirthdate, deceased, address-state, gender, link, language, address-country, death-date, phonetic, telecom, address-city, email, given, identifier, address, general-practitioner, active, address-postalcode, phone, organization, address-use, name, family
Practitionerhttp://hl7.it/fhir/StructureDefinition/Practitioner-it-baseyyaddress-state, gender, address-country, phonetic, telecom, address-city, communication, email, given, identifier, address, _security, active, address-postalcode, phone, address-use, name, family

Resource Conformance: supported MedicationDispense

Base System Profile
http://hl7.it/fhir/dossier-pharma/StructureDefinition/MedicationDispense-it-dossierPharma
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLsubjectreference

Permette di ricercare per identificativo del paziente

SHALLwhenhandedoverdate

Quando è stata erogata la ricetta

SHALLcodetoken

Permette di ricercare per il codice AIC o ATC del farmaco erogato

 

Resource Conformance: supported MedicationRequest

Base System Profile
http://hl7.it/fhir/dossier-pharma/StructureDefinition/MedicationRequest-it-dossierPharma
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLsubjectreference

Permette di ricercare per identificativo del paziente

SHALLauthoredondate

Quando è stata compilata la ricetta

SHALLcodetoken

Permette di ricercare per il codice AIC o ATC del farmaco erogato

 

Resource Conformance: supported Provenance

Base System Profile
http://hl7.it/fhir/dossier-pharma/StructureDefinition/Provenance-it-dossierPharma
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLtargetreference

Permette di ricercare in base alle risorse associate

SHALLentityreference

permette di ricercare in base ai metadati necessari per accedere ad un documento nel profilo XDS definito da IHE. In particolare deve veicolare il documentEntry.repositoryUniqueId ed il documentEntry.UniqueID del documento referenziato nella risorsa Provenance (e.g. entity:identifier=RepoID|DocUniqueId)

 

Resource Conformance: supported PractitionerRole

Base System Profile
http://hl7.it/fhir/dossier-pharma/StructureDefinition/PractitionerRole-prescrittore-it-dossierPharma
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Permette di ricercare in base all'identifier del PractitionerRole

 

Resource Conformance: supported Location

Base System Profile
http://hl7.it/fhir/dossier-pharma/StructureDefinition/Location-it-dossierPharma
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Permette di ricercare in base all'identifier della Location

 

Resource Conformance: supported Medication

Base System Profile
http://hl7.it/fhir/dossier-pharma/StructureDefinition/Medication-it-dossierPharma
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Permette di ricercare in base all'identifier della Medication

SHALLcodetoken

Permette di ricercare in base al codice relativo alla Medication

 

Resource Conformance: supported Patient

Base System Profile
http://hl7.it/fhir/StructureDefinition/Patient-it-base
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLbirthdatedate

Multiple Resources:

  • [Patient]: The patient's date of birth
  • [Person]: The person's date of birth
  • [RelatedPerson]: The Related Person's date of birth
SHALLdeceasedtoken

This patient has been marked as deceased, or as a death date entered

SHALLaddress-statestring

Multiple Resources:

  • [Patient]: A state specified in an address
  • [Person]: A state specified in an address
  • [Practitioner]: A state specified in an address
  • [RelatedPerson]: A state specified in an address
SHALLgendertoken

Multiple Resources:

  • [Patient]: Gender of the patient
  • [Person]: The gender of the person
  • [Practitioner]: Gender of the practitioner
  • [RelatedPerson]: Gender of the related person
SHALLlinkreference

All patients linked to the given patient

SHALLlanguagetoken

Language code (irrespective of use value)

SHALLaddress-countrystring

Multiple Resources:

  • [Patient]: A country specified in an address
  • [Person]: A country specified in an address
  • [Practitioner]: A country specified in an address
  • [RelatedPerson]: A country specified in an address
SHALLdeath-datedate

The date of death has been provided and satisfies this search value

SHALLphoneticstring

Multiple Resources:

  • [Patient]: A portion of either family or given name using some kind of phonetic matching algorithm
  • [Person]: A portion of name using some kind of phonetic matching algorithm
  • [Practitioner]: A portion of either family or given name using some kind of phonetic matching algorithm
  • [RelatedPerson]: A portion of name using some kind of phonetic matching algorithm
SHALLtelecomtoken

Multiple Resources:

  • [Patient]: The value in any kind of telecom details of the patient
  • [Person]: The value in any kind of contact
  • [Practitioner]: The value in any kind of contact
  • [PractitionerRole]: The value in any kind of contact
  • [RelatedPerson]: The value in any kind of contact
SHALLaddress-citystring

Multiple Resources:

  • [Patient]: A city specified in an address
  • [Person]: A city specified in an address
  • [Practitioner]: A city specified in an address
  • [RelatedPerson]: A city specified in an address
SHALLemailtoken

Multiple Resources:

  • [Patient]: A value in an email contact
  • [Person]: A value in an email contact
  • [Practitioner]: A value in an email contact
  • [PractitionerRole]: A value in an email contact
  • [RelatedPerson]: A value in an email contact
SHALLgivenstring

Multiple Resources:

  • [Patient]: A portion of the given name of the patient
  • [Practitioner]: A portion of the given name
SHALLidentifiertoken

A patient identifier

SHALLaddressstring

Multiple Resources:

  • [Patient]: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
  • [Person]: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
  • [Practitioner]: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
  • [RelatedPerson]: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
SHALLgeneral-practitionerreference

Patient's nominated general practitioner, not the organization that manages the record

SHALLactivetoken

Whether the patient record is active

SHALLaddress-postalcodestring

Multiple Resources:

  • [Patient]: A postalCode specified in an address
  • [Person]: A postal code specified in an address
  • [Practitioner]: A postalCode specified in an address
  • [RelatedPerson]: A postal code specified in an address
SHALLphonetoken

Multiple Resources:

  • [Patient]: A value in a phone contact
  • [Person]: A value in a phone contact
  • [Practitioner]: A value in a phone contact
  • [PractitionerRole]: A value in a phone contact
  • [RelatedPerson]: A value in a phone contact
SHALLorganizationreference

The organization that is the custodian of the patient record

SHALLaddress-usetoken

Multiple Resources:

  • [Patient]: A use code specified in an address
  • [Person]: A use code specified in an address
  • [Practitioner]: A use code specified in an address
  • [RelatedPerson]: A use code specified in an address
SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

SHALLfamilystring

Multiple Resources:

  • [Patient]: A portion of the family name of the patient
  • [Practitioner]: A portion of the family name
 

Resource Conformance: supported Practitioner

Base System Profile
http://hl7.it/fhir/StructureDefinition/Practitioner-it-base
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLaddress-statestring

Multiple Resources:

  • [Patient]: A state specified in an address
  • [Person]: A state specified in an address
  • [Practitioner]: A state specified in an address
  • [RelatedPerson]: A state specified in an address
SHALLgendertoken

Multiple Resources:

  • [Patient]: Gender of the patient
  • [Person]: The gender of the person
  • [Practitioner]: Gender of the practitioner
  • [RelatedPerson]: Gender of the related person
SHALLaddress-countrystring

Multiple Resources:

  • [Patient]: A country specified in an address
  • [Person]: A country specified in an address
  • [Practitioner]: A country specified in an address
  • [RelatedPerson]: A country specified in an address
SHALLphoneticstring

Multiple Resources:

  • [Patient]: A portion of either family or given name using some kind of phonetic matching algorithm
  • [Person]: A portion of name using some kind of phonetic matching algorithm
  • [Practitioner]: A portion of either family or given name using some kind of phonetic matching algorithm
  • [RelatedPerson]: A portion of name using some kind of phonetic matching algorithm
SHALLtelecomtoken

Multiple Resources:

  • [Patient]: The value in any kind of telecom details of the patient
  • [Person]: The value in any kind of contact
  • [Practitioner]: The value in any kind of contact
  • [PractitionerRole]: The value in any kind of contact
  • [RelatedPerson]: The value in any kind of contact
SHALLaddress-citystring

Multiple Resources:

  • [Patient]: A city specified in an address
  • [Person]: A city specified in an address
  • [Practitioner]: A city specified in an address
  • [RelatedPerson]: A city specified in an address
SHALLcommunicationtoken

One of the languages that the practitioner can communicate with

SHALLemailtoken

Multiple Resources:

  • [Patient]: A value in an email contact
  • [Person]: A value in an email contact
  • [Practitioner]: A value in an email contact
  • [PractitionerRole]: A value in an email contact
  • [RelatedPerson]: A value in an email contact
SHALLgivenstring

Multiple Resources:

  • [Patient]: A portion of the given name of the patient
  • [Practitioner]: A portion of the given name
SHALLidentifiertoken

A practitioner's Identifier

SHALLaddressstring

Multiple Resources:

  • [Patient]: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
  • [Person]: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
  • [Practitioner]: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
  • [RelatedPerson]: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
SHALL_securitytoken

Security Labels applied to this resource

SHALLactivetoken

Whether the practitioner record is active

SHALLaddress-postalcodestring

Multiple Resources:

  • [Patient]: A postalCode specified in an address
  • [Person]: A postal code specified in an address
  • [Practitioner]: A postalCode specified in an address
  • [RelatedPerson]: A postal code specified in an address
SHALLphonetoken

Multiple Resources:

  • [Patient]: A value in a phone contact
  • [Person]: A value in a phone contact
  • [Practitioner]: A value in a phone contact
  • [PractitionerRole]: A value in a phone contact
  • [RelatedPerson]: A value in a phone contact
SHALLaddress-usetoken

Multiple Resources:

  • [Patient]: A use code specified in an address
  • [Person]: A use code specified in an address
  • [Practitioner]: A use code specified in an address
  • [RelatedPerson]: A use code specified in an address
SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

SHALLfamilystring

Multiple Resources:

  • [Patient]: A portion of the family name of the patient
  • [Practitioner]: A portion of the family name