Annuaire Santé
1.0.0-ballot-4 - trial-use France flag

This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.0.0-ballot-4: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Data Type Profile: AS Mailbox MSS Datatype Profile

Official URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-mailbox-mss Version: 1.0.0-ballot-4
Active as of 2024-04-02 Computable Name: AsMailboxMSSProfile

Datatype profile créé à partir ContactPoint dans le cadre de l’Annuaire Santé pour décrire les boîtes aux lettres du service de messagerie sécurisée de santé (MSSanté) rattachées aux professionnels et aux structures.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from FrContactPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint FrContactPoint
... extension:emailType 0..1FrContactPointEmailTypeType of email | type de messagerie électronique
.... extension 0..0
.... value[x] 0..1CodingValue of extension
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: https://mos.esante.gouv.fr/NOS/TRE_R256-TypeMessagerie/FHIR/TRE-R256-TypeMessagerie
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MSSANTE
... as-mailbox-mss-metadata 0..1(Complex)Les attributs 'responsible' et 'phone' ne sont pas disponibles en accès libre.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-mailbox-mss-metadata
... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C0..*FrContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... emailType 0..1CodingType of email | type de messagerie électronique
URL: http://interopsante.org/fhir/StructureDefinition/FrContactPointEmailType
Binding: fr-email-type (extensible)
.... extension 0..0
.... url 1..1uri"http://interopsante.org/fhir/StructureDefinition/FrContactPointEmailType"
.... value[x] 0..1CodingValue of extension
Binding: fr-email-type (extensible)
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: https://mos.esante.gouv.fr/NOS/TRE_R256-TypeMessagerie/FHIR/TRE-R256-TypeMessagerie
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MSSANTE
... as-mailbox-mss-metadata 0..1(Complex)Les attributs 'responsible' et 'phone' ne sont pas disponibles en accès libre.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-mailbox-mss-metadata
... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ContactPoint.extension:emailType.value[x]extensiblePattern: MSSANTE
http://interopsante.org/fhir/ValueSet/fr-email-type
ContactPoint.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
ContactPoint.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorContactPointA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorContactPoint.extension:emailType, ContactPoint.extension:as-mailbox-mss-metadataMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C0..*FrContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... id 0..1stringUnique id for inter-element referencing
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... emailType 0..1CodingType of email | type de messagerie électronique
URL: http://interopsante.org/fhir/StructureDefinition/FrContactPointEmailType
Binding: fr-email-type (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://interopsante.org/fhir/StructureDefinition/FrContactPointEmailType"
.... value[x] 0..1CodingValue of extension
Binding: fr-email-type (extensible)
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: https://mos.esante.gouv.fr/NOS/TRE_R256-TypeMessagerie/FHIR/TRE-R256-TypeMessagerie
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MSSANTE
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
... value SΣ1..1stringBoîte Aux Lettres (BAL) MSS
... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
... period ΣC0..1PeriodTime period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ContactPoint.extension:emailType.value[x]extensiblePattern: MSSANTE
http://interopsante.org/fhir/ValueSet/fr-email-type
ContactPoint.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
ContactPoint.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorContactPointA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorContactPoint.extension, ContactPoint.extension:emailType, ContactPoint.extension:as-mailbox-mss-metadataMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorContactPoint.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)

This structure is derived from FrContactPoint

Summary

Must-Support: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from FrContactPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint FrContactPoint
... extension:emailType 0..1FrContactPointEmailTypeType of email | type de messagerie électronique
.... extension 0..0
.... value[x] 0..1CodingValue of extension
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: https://mos.esante.gouv.fr/NOS/TRE_R256-TypeMessagerie/FHIR/TRE-R256-TypeMessagerie
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MSSANTE
... as-mailbox-mss-metadata 0..1(Complex)Les attributs 'responsible' et 'phone' ne sont pas disponibles en accès libre.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-mailbox-mss-metadata
... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C0..*FrContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... emailType 0..1CodingType of email | type de messagerie électronique
URL: http://interopsante.org/fhir/StructureDefinition/FrContactPointEmailType
Binding: fr-email-type (extensible)
.... extension 0..0
.... url 1..1uri"http://interopsante.org/fhir/StructureDefinition/FrContactPointEmailType"
.... value[x] 0..1CodingValue of extension
Binding: fr-email-type (extensible)
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: https://mos.esante.gouv.fr/NOS/TRE_R256-TypeMessagerie/FHIR/TRE-R256-TypeMessagerie
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MSSANTE
... as-mailbox-mss-metadata 0..1(Complex)Les attributs 'responsible' et 'phone' ne sont pas disponibles en accès libre.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-mailbox-mss-metadata
... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ContactPoint.extension:emailType.value[x]extensiblePattern: MSSANTE
http://interopsante.org/fhir/ValueSet/fr-email-type
ContactPoint.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
ContactPoint.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorContactPointA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorContactPoint.extension:emailType, ContactPoint.extension:as-mailbox-mss-metadataMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C0..*FrContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... id 0..1stringUnique id for inter-element referencing
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... emailType 0..1CodingType of email | type de messagerie électronique
URL: http://interopsante.org/fhir/StructureDefinition/FrContactPointEmailType
Binding: fr-email-type (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://interopsante.org/fhir/StructureDefinition/FrContactPointEmailType"
.... value[x] 0..1CodingValue of extension
Binding: fr-email-type (extensible)
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: https://mos.esante.gouv.fr/NOS/TRE_R256-TypeMessagerie/FHIR/TRE-R256-TypeMessagerie
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: MSSANTE
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
... value SΣ1..1stringBoîte Aux Lettres (BAL) MSS
... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
... period ΣC0..1PeriodTime period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ContactPoint.extension:emailType.value[x]extensiblePattern: MSSANTE
http://interopsante.org/fhir/ValueSet/fr-email-type
ContactPoint.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
ContactPoint.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorContactPointA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorContactPoint.extension, ContactPoint.extension:emailType, ContactPoint.extension:as-mailbox-mss-metadataMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorContactPoint.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)

This structure is derived from FrContactPoint

Summary

Must-Support: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron