| Datatypes UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
A label that uniquely identifies a thing or object. This data type represents a "identifier" - some series of letters or numbers which uniquely identifies something. In practice, this data type will be substituted with specific "flavors" of the Id data type for use in particular standards-based payloads."A technical identifier - identifies some entity uniquely and unambiguously." - HL7 FHIR, Identifier.
Attributes | ||
«IVL_TS» Period | effectiveDateRange |
The time period during which the id is known to be valid. The data type is a TimeInterval, which includes both a start date and end date, either of which may be empty."Time period during which identifier is/was valid for use." - HL7 FHIR, Identifier.period. |
String | idType |
Indicates what kind of identifier is being represented. For example, the idType might be represent a Driver's License, in which case the assigning Authority might be the Virginia Department of Motor Vehicles.Note that: a) this information can (and probably should) be also be made clear by the name and definition of the property whose data type is an Id; and b) this property might be an enumeration in the future."A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." - HL7 FHIR, Identifier.type."Code to identify the type of ID in PAT03 [Id of Patient]." - ASAP Standard for PDMP, PAT02: ID Qualifier"Code to identify the type of ID in PAT06 [Additional Patient ID Qualifier] if the PDMP requires a second identifier." - ASAP Standard for PDMP, PAT05: Additional Patient ID QualifierPossible values include: Military ID; State Issued ID; Unique System ID; Permanent Resident Card (Green Card); Passport ID; Driver’s License ID; Social Security Number; Tribal ID; Other (Trading partner agreed upon ID, such as cardholder ID.) |
String | system |
A unique identifier of the system (or organization or agency or department) that created the data and/or issued or manages the identifier.Note that this property may be replaced by some other concept or group of concepts when this abstract class is replaced by a specific class for a given target platform."Establishes the namespace in which set of possible id values is unique." - HL7 FHIR, Identifier.assigner."Code identifying the jurisdiction that issues the ID in PAT03 [Id of Patient]." - ASAP Standard for PDMP, PAT01: ID Qualifier of Patient Identifier"Code identifying the jurisdiction that issues the ID in PAT06 [Additional Patient ID Qualifier]. Used if the PDMP requires such identification." - ASAP Standard for PDMP, PAT04: ID Qualifier of Additional Patient Identifier (Situational) |
String | value |
A unique label that identifies an individual entity within a group of entities. The identifier must be unique within the system that defined it (i.e., the assigningAuthority).Note that this property may be replaced by some other concept or group of concepts when this abstract class is replaced by a specific class for a given target platform."The portion of the identifier typically displayed to the user and which is unique within the context of the system." - HL7 FHIR, Identifier.value. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | II |
Name | Id |
Name Expression | |
Namespace | Datatypes |
Owned Template Signature | |
Owner | Datatypes |
Owning Template Parameter | |
Package | Datatypes |
Qualified Name | FHIM::Datatypes::Id |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «IVL_TS» Period effectiveDateRange
The time period during which the id is known to be valid. The data type is a TimeInterval, which includes both a start date and end date, either of which may be empty."Time period during which identifier is/was valid for use." - HL7 FHIR, Identifier.period.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «II» Id |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | effectiveDateRange |
Name Expression | |
Namespace | «II» Id |
Opposite | |
Owner | «II» Id |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::Id::effectiveDateRange |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String idType
Indicates what kind of identifier is being represented. For example, the idType might be represent a Driver's License, in which case the assigning Authority might be the Virginia Department of Motor Vehicles.Note that: a) this information can (and probably should) be also be made clear by the name and definition of the property whose data type is an Id; and b) this property might be an enumeration in the future."A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." - HL7 FHIR, Identifier.type."Code to identify the type of ID in PAT03 [Id of Patient]." - ASAP Standard for PDMP, PAT02: ID Qualifier"Code to identify the type of ID in PAT06 [Additional Patient ID Qualifier] if the PDMP requires a second identifier." - ASAP Standard for PDMP, PAT05: Additional Patient ID QualifierPossible values include: Military ID; State Issued ID; Unique System ID; Permanent Resident Card (Green Card); Passport ID; Driver’s License ID; Social Security Number; Tribal ID; Other (Trading partner agreed upon ID, such as cardholder ID.)
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «II» Id |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | idType |
Name Expression | |
Namespace | «II» Id |
Opposite | |
Owner | «II» Id |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::Id::idType |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String system
A unique identifier of the system (or organization or agency or department) that created the data and/or issued or manages the identifier.Note that this property may be replaced by some other concept or group of concepts when this abstract class is replaced by a specific class for a given target platform."Establishes the namespace in which set of possible id values is unique." - HL7 FHIR, Identifier.assigner."Code identifying the jurisdiction that issues the ID in PAT03 [Id of Patient]." - ASAP Standard for PDMP, PAT01: ID Qualifier of Patient Identifier"Code identifying the jurisdiction that issues the ID in PAT06 [Additional Patient ID Qualifier]. Used if the PDMP requires such identification." - ASAP Standard for PDMP, PAT04: ID Qualifier of Additional Patient Identifier (Situational)
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «II» Id |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | system |
Name Expression | |
Namespace | «II» Id |
Opposite | |
Owner | «II» Id |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::Id::system |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String value
A unique label that identifies an individual entity within a group of entities. The identifier must be unique within the system that defined it (i.e., the assigningAuthority).Note that this property may be replaced by some other concept or group of concepts when this abstract class is replaced by a specific class for a given target platform."The portion of the identifier typically displayed to the user and which is unique within the context of the system." - HL7 FHIR, Identifier.value.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «II» Id |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | value |
Name Expression | |
Namespace | «II» Id |
Opposite | |
Owner | «II» Id |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::Id::value |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Datatypes UML Documentation |
Summary:AttributesProperties | Detail:Attributes |