Annuaire Santé
1.0.0-ballot-2 - STU1
Annuaire Santé
1.0.0-ballot-2 - STU1
This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.0.0-ballot-2: 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
| Official URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-device | Version: 1.0.0-ballot-2 | |||
| Active as of 2023-07-18 | Computable Name: AsDeviceProfile | |||
Profil créé à partir de Device dans le contexte de l’Annuaire Santé pour décrire les équipements matériels lourds (‘EML’) mis en oeuvre au sein d’un établissement.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Device
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  Device | 0..* | Device | Item used in healthcare | |||||
  id | Σ | 0..1 | id | Logical id of this artifact | ||||
  meta | ΣN | 0..1 | Meta | Metadata about the resource | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
 Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
 as-ext-data-trace | S | 0..1 | (Complex) | DataTrace URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace | ||||
| versionId | ΣN | 0..1 | id | Version specific identifier | ||||
| lastUpdated | ΣN | 0..1 | instant | When the resource version last changed | ||||
| source | ΣN | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | ΣN | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | ΣN | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
 tag | ΣN | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created | ||||
| language | N | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
| text | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| as-ext-device-number-authorization-arhgos | S | 0..1 | string | Identifiant fonctionnel de l'autorisation ARHGOS de l'EML. URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-device-number-authorization-arhgos | ||||
| as-ext-device-authorization-date-device | S | 0..1 | date | Date de délivrance de l’autorisation d’EML. URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-device-authorization-date-device | ||||
| as-ext-device-Period-implantation | S | 0..1 | Period | Dates de mise en oeuvre de l'EML URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-device-Period-implantation | ||||
 modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | S | 0..* | Identifier | Identifiant fonctionnel de l'autorisation ARHGOS de l'EML (Synonyme : numeroAutorisationARHGOS). | ||||
 definition | CN | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | ||||
| udiCarrier | ΣN | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| deviceIdentifier | ΣN | 0..1 | string | Mandatory fixed portion of UDI | ||||
| issuer | N | 0..1 | uri | UDI Issuing Organization | ||||
| jurisdiction | N | 0..1 | uri | Regional UDI authority | ||||
| carrierAIDC | ΣN | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
| carrierHRF | ΣN | 0..1 | string | UDI Human Readable Barcode String | ||||
| entryType | N | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | ||||
| status | ?!SΣ | 0..1 | code | Le matériel est-il actif? active | inactive Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
| statusReason | N | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | ||||
| distinctIdentifier | N | 0..1 | string | The distinct identification string | ||||
| manufacturer | S | 0..1 | string | Marque de l'équipement matériel lourd. | ||||
| manufactureDate | N | 0..1 | dateTime | Date when the device was made | ||||
| expirationDate | N | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | ||||
| lotNumber | N | 0..1 | string | Lot number of manufacture | ||||
| serialNumber | S | 0..1 | string | Numéro de série de l'équipement matériel lourd (Synonyme : numeroSerie). | ||||
| deviceName | N | 0..* | BackboneElement | The name of the device as given by the manufacturer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | N | 1..1 | string | The name of the device | ||||
| type | N | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | ||||
| modelNumber | N | 0..1 | string | The model number for the device | ||||
| partNumber | N | 0..1 | string | The part number of the device | ||||
| type | S | 0..1 | CodeableConcept | Code définissant l'équipement matériel lourd (EML) soumis à autorisation. Binding: https://mos.esante.gouv.fr/NOS/JDV_J135-EquipementMaterielLourd-RASS/FHIR/JDV-J135-EquipementMaterielLourd-RASS (required): Liste des types d'EML (Synonyme : equipementMaterielLourd) | ||||
| specialization | N | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| systemType | N | 1..1 | CodeableConcept | The standard that is used to operate and communicate | ||||
| version | N | 0..1 | string | The version of the standard that is used to operate and communicate | ||||
| version | N | 0..* | BackboneElement | The actual design of the device or software version running on the device | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | N | 0..1 | CodeableConcept | The type of the device version | ||||
| component | N | 0..1 | Identifier | A single component of the device version | ||||
| value | N | 1..1 | string | The version text | ||||
| property | N | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | N | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | ||||
| valueQuantity | CN | 0..* | Quantity | Property value as a quantity | ||||
| valueCode | N | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | ||||
| patient | CN | 0..1 | Reference(Patient) | Patient to whom Device is affixed | ||||
| owner | SC | 0..1 | Reference(FrOrganization | AS Organization Profile) | Référence vers l'id de la structure FINESS ET à laquelle est rattaché cet équipement matériel lourd (Synonyme : idStructure). | ||||
| contact | CN | 0..* | ContactPoint | Details for human/organization for support | ||||
| location | CN | 0..1 | Reference(Location) | Where the device is found | ||||
| url | N | 0..1 | uri | Network address to contact device | ||||
| note | N | 0..* | Annotation | Device notes and comments | ||||
| safety | ΣN | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
| parent | CN | 0..1 | Reference(Device) | The parent device | ||||
| Documentation for this format | ||||||||
This structure is derived from Device
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Device
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Device | 0..* | Device | Item used in healthcare | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | ΣN | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| as-ext-data-trace | S | 0..1 | (Complex) | DataTrace URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace | ||||
| versionId | ΣN | 0..1 | id | Version specific identifier | ||||
| lastUpdated | ΣN | 0..1 | instant | When the resource version last changed | ||||
| source | ΣN | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | ΣN | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | ΣN | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | ΣN | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created | ||||
| language | N | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
| text | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| as-ext-device-number-authorization-arhgos | S | 0..1 | string | Identifiant fonctionnel de l'autorisation ARHGOS de l'EML. URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-device-number-authorization-arhgos | ||||
| as-ext-device-authorization-date-device | S | 0..1 | date | Date de délivrance de l’autorisation d’EML. URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-device-authorization-date-device | ||||
| as-ext-device-Period-implantation | S | 0..1 | Period | Dates de mise en oeuvre de l'EML URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-device-Period-implantation | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | S | 0..* | Identifier | Identifiant fonctionnel de l'autorisation ARHGOS de l'EML (Synonyme : numeroAutorisationARHGOS). | ||||
| definition | CN | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | ||||
| udiCarrier | ΣN | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| deviceIdentifier | ΣN | 0..1 | string | Mandatory fixed portion of UDI | ||||
| issuer | N | 0..1 | uri | UDI Issuing Organization | ||||
| jurisdiction | N | 0..1 | uri | Regional UDI authority | ||||
| carrierAIDC | ΣN | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
| carrierHRF | ΣN | 0..1 | string | UDI Human Readable Barcode String | ||||
| entryType | N | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | ||||
| status | ?!SΣ | 0..1 | code | Le matériel est-il actif? active | inactive Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
| statusReason | N | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | ||||
| distinctIdentifier | N | 0..1 | string | The distinct identification string | ||||
| manufacturer | S | 0..1 | string | Marque de l'équipement matériel lourd. | ||||
| manufactureDate | N | 0..1 | dateTime | Date when the device was made | ||||
| expirationDate | N | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | ||||
| lotNumber | N | 0..1 | string | Lot number of manufacture | ||||
| serialNumber | S | 0..1 | string | Numéro de série de l'équipement matériel lourd (Synonyme : numeroSerie). | ||||
| deviceName | N | 0..* | BackboneElement | The name of the device as given by the manufacturer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | N | 1..1 | string | The name of the device | ||||
| type | N | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | ||||
| modelNumber | N | 0..1 | string | The model number for the device | ||||
| partNumber | N | 0..1 | string | The part number of the device | ||||
| type | S | 0..1 | CodeableConcept | Code définissant l'équipement matériel lourd (EML) soumis à autorisation. Binding: https://mos.esante.gouv.fr/NOS/JDV_J135-EquipementMaterielLourd-RASS/FHIR/JDV-J135-EquipementMaterielLourd-RASS (required): Liste des types d'EML (Synonyme : equipementMaterielLourd) | ||||
| specialization | N | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| systemType | N | 1..1 | CodeableConcept | The standard that is used to operate and communicate | ||||
| version | N | 0..1 | string | The version of the standard that is used to operate and communicate | ||||
| version | N | 0..* | BackboneElement | The actual design of the device or software version running on the device | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | N | 0..1 | CodeableConcept | The type of the device version | ||||
| component | N | 0..1 | Identifier | A single component of the device version | ||||
| value | N | 1..1 | string | The version text | ||||
| property | N | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | N | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | ||||
| valueQuantity | CN | 0..* | Quantity | Property value as a quantity | ||||
| valueCode | N | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | ||||
| patient | CN | 0..1 | Reference(Patient) | Patient to whom Device is affixed | ||||
| owner | SC | 0..1 | Reference(FrOrganization | AS Organization Profile) | Référence vers l'id de la structure FINESS ET à laquelle est rattaché cet équipement matériel lourd (Synonyme : idStructure). | ||||
| contact | CN | 0..* | ContactPoint | Details for human/organization for support | ||||
| location | CN | 0..1 | Reference(Location) | Where the device is found | ||||
| url | N | 0..1 | uri | Network address to contact device | ||||
| note | N | 0..* | Annotation | Device notes and comments | ||||
| safety | ΣN | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
| parent | CN | 0..1 | Reference(Device) | The parent device | ||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | ||||
| Device.meta.security | extensible | All Security Labels | ||||
| Device.meta.tag | example | CommonTags | ||||
| Device.language | preferred | CommonLanguages
| ||||
| Device.udiCarrier.entryType | required | UDIEntryType | ||||
| Device.status | required | FHIRDeviceStatus | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReason | ||||
| Device.deviceName.type | required | DeviceNameType | ||||
| Device.type | required | https://mos.esante.gouv.fr/NOS/JDV_J135-EquipementMaterielLourd-RASS/FHIR/JDV-J135-EquipementMaterielLourd-RASS |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Device.contact | A system is required if a value is provided. : value.empty() or system.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| qty-3 | error | Device.property.valueQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| ref-1 | error | Device.definition, Device.patient, Device.owner, Device.location, Device.parent | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
