Search FHIR

ANS IG document core
0.1.0 - ci-build France flag

ANS IG document core - version de développement local (v0.1.0) construite par les outils de publication FHIR (HL7® FHIR® Standard). Voir le répertoire des versions publiées

Data Type Profile: FRStudyInstanceUidIdentifierDocument - Detailed Descriptions

Draft as of 2025-12-05

Definitions for the fr-study-instance-uid-identifier-document data type profile.

Des conseils sur linterprétation du contenu de ce tableau peuvent être trouvésici

0. Identifier
Définition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

CourtAn identifier intended for computation
Contrôle0..*
Cet élément est affecté par les invariants suivants : ele-1
Est modificateurfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Identifier.use
Définition

The purpose of this identifier.

Courtusual | official | temp | secondary | old (If known)
Commentaires

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Contrôle0..1
BindingLes codes DOIVENT (SHALL) être pris de IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Est modificateurtrue parce que This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Exigences

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Identifier.system
Définition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

CourtThe namespace for the identifier value
Commentaires

Identifier.system is always case sensitive.

Contrôle0..1
Typeuri
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
Exigences

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Valeur de motifurn:dicom:uid
ExempleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Identifier.value
Définition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

CourtThe value that is unique
Commentaires

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Contrôle10..1
Typestring
Est modificateurfalse
Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
Résumétrue
ExempleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Des conseils sur linterprétation du contenu de ce tableau peuvent être trouvésici

0. Identifier
2. Identifier.type
4. Identifier.type.coding
6. Identifier.type.coding.code
Valeur de motif0020000D
8. Identifier.system
Valeur de motifurn:dicom:uid
10. Identifier.value
Contrôle1..?

Des conseils sur linterprétation du contenu de ce tableau peuvent être trouvésici

0. Identifier
Définition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

CourtAn identifier intended for computation
Contrôle0..*
Cet élément est affecté par les invariants suivants : ele-1
Est modificateurfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Identifier.id
Définition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

CourtUnique id for inter-element referencing
Contrôle0..1
Typestring
Est modificateurfalse
Format XMLDans le format XML, cette propriété est représentée comme attribut.
Résuméfalse
4. Identifier.extension
Définition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CourtAdditional content defined by implementations
Commentaires

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contrôle0..*
TypeExtension
Est modificateurfalse
Résuméfalse
Noms alternatifsextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingCet élément introduit un ensemble de slices sur Identifier.extension. Les slices sontNon ordonné et Open, et peut être différencié en utilisant les discriminateurs suivants :
  • value @ url
  • 6. Identifier.use
    Définition

    The purpose of this identifier.

    Courtusual | official | temp | secondary | old (If known)
    Commentaires

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Contrôle0..1
    BindingLes codes DOIVENT (SHALL) être pris de IdentifierUse
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Est modificateurtrue parce que This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
    Résumétrue
    Exigences

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. Identifier.type
    Définition

    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    CourtDescription of identifier
    Commentaires

    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

    Contrôle0..1
    BindingSauf si inapproprié, ces codes DOIVENT (SHALL) être pris de Identifier Type Codes
    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TypeCodeableConcept
    Est modificateurfalse
    Résumétrue
    Exigences

    Allows users to make use of identifiers when the identifier system is not known.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Identifier.type.id
    Définition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    CourtUnique id for inter-element referencing
    Contrôle0..1
    Typestring
    Est modificateurfalse
    Format XMLDans le format XML, cette propriété est représentée comme attribut.
    Résuméfalse
    12. Identifier.type.extension
    Définition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    CourtAdditional content defined by implementations
    Commentaires

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Contrôle0..*
    TypeExtension
    Est modificateurfalse
    Résuméfalse
    Noms alternatifsextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingCet élément introduit un ensemble de slices sur Identifier.type.extension. Les slices sontNon ordonné et Open, et peut être différencié en utilisant les discriminateurs suivants :
    • value @ url
    • 14. Identifier.type.coding
      Définition

      A reference to a code defined by a terminology system.

      CourtCode defined by a terminology system
      Commentaires

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Contrôle0..*
      TypeCoding
      Est modificateurfalse
      Résumétrue
      Exigences

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Identifier.type.coding.id
      Définition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      CourtUnique id for inter-element referencing
      Contrôle0..1
      Typestring
      Est modificateurfalse
      Format XMLDans le format XML, cette propriété est représentée comme attribut.
      Résuméfalse
      18. Identifier.type.coding.extension
      Définition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      CourtAdditional content defined by implementations
      Commentaires

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Contrôle0..*
      TypeExtension
      Est modificateurfalse
      Résuméfalse
      Noms alternatifsextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingCet élément introduit un ensemble de slices sur Identifier.type.coding.extension. Les slices sontNon ordonné et Open, et peut être différencié en utilisant les discriminateurs suivants :
      • value @ url
      • 20. Identifier.type.coding.system
        Définition

        The identification of the code system that defines the meaning of the symbol in the code.

        CourtIdentity of the terminology system
        Commentaires

        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

        Contrôle0..1
        Typeuri
        Est modificateurfalse
        Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
        Résumétrue
        Exigences

        Need to be unambiguous about the source of the definition of the symbol.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Identifier.type.coding.version
        Définition

        The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

        CourtVersion of the system - if relevant
        Commentaires

        Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

        NoteCeci est un ID de version métier, pas un ID de version de ressource (voir discussion)
        Contrôle0..1
        Typestring
        Est modificateurfalse
        Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
        Résumétrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. Identifier.type.coding.code
        Définition

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        CourtSymbol in syntax defined by the system
        Contrôle0..1
        Typecode
        Est modificateurfalse
        Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
        Résumétrue
        Exigences

        Need to refer to a particular code in the system.

        Valeur de motif0020000D
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. Identifier.type.coding.display
        Définition

        A representation of the meaning of the code in the system, following the rules of the system.

        CourtRepresentation defined by the system
        Contrôle0..1
        Typestring
        Est modificateurfalse
        Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
        Résumétrue
        Exigences

        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. Identifier.type.coding.userSelected
        Définition

        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

        CourtIf this coding was chosen directly by the user
        Commentaires

        Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

        Contrôle0..1
        Typeboolean
        Est modificateurfalse
        Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
        Résumétrue
        Exigences

        This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. Identifier.type.text
        Définition

        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

        CourtPlain text representation of the concept
        Commentaires

        Very often the text is the same as a displayName of one of the codings.

        Contrôle0..1
        Typestring
        Est modificateurfalse
        Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
        Résumétrue
        Exigences

        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. Identifier.system
        Définition

        Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        CourtThe namespace for the identifier value
        Commentaires

        Identifier.system is always case sensitive.

        Contrôle0..1
        Typeuri
        Est modificateurfalse
        Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
        Résumétrue
        Exigences

        There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

        Valeur de motifurn:dicom:uid
        ExempleGeneral: http://www.acme.com/identifiers/patient
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. Identifier.value
        Définition

        The portion of the identifier typically relevant to the user and which is unique within the context of the system.

        CourtThe value that is unique
        Commentaires

        If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

        Contrôle1..1
        Typestring
        Est modificateurfalse
        Valeur primitiveCet élément primitif peut être présent, absent ou remplacé par une extension
        Résumétrue
        ExempleGeneral: 123456
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Identifier.period
        Définition

        Time period during which identifier is/was valid for use.

        CourtTime period when id is/was valid for use
        Contrôle0..1
        TypePeriod
        Est modificateurfalse
        Résumétrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Identifier.assigner
        Définition

        Organization that issued/manages the identifier.

        CourtOrganization that issued id (may be just text)
        Commentaires

        The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

        Contrôle0..1
        TypeReference(Organization)
        Est modificateurfalse
        Résumétrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))