Patient Constrained
- Path
- Patient
- Cardinality
- 0..*
- Short Description
- Information about an individual or animal receiving health care services
- Definition
- Demographics and other administrative information about an individual or animal receiving
care or other health-related services.
- Base
- Patient [0..*]
- Alias
- SubjectOfCare Client Resident
Mapping
- rim:Entity. Role, or Act
- rim:Patient[classCode=PAT]
- cda:ClinicalDocument.recordTarget.patientRole
Constraints
- Severity
- errordom-2
- Description
- If the resource is contained in another resource, it SHALL NOT contain nested Resources
- Expression
contained.contained.empty()- XPath
- not(parent::f:contained and f:contained)
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
- Severity
- errordom-4
- Description
- If a resource is contained in another resource, it SHALL NOT have a meta.versionId
or a meta.lastUpdated
- Expression
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()- XPath
- not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
- Severity
- errordom-3
- Description
- If the resource is contained in another resource, it SHALL be referred to from elsewhere
in the resource or SHALL refer to the containing resource
- Expression
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical)
| %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference
= '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical)
= '#').exists()).not()).trace('unmatched', id).empty()- XPath
- not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#',
$contained/*/id/@value) or descendant::f:reference[@value='#'])]))
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
- Severity
- warningdom-6
- Description
- A resource should have narrative for robust management
- Expression
text.`div`.exists()- XPath
- exists(f:text/h:div)
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
- Severity
- errordom-5
- Description
- If a resource is contained in another resource, it SHALL NOT have a security label
- Expression
contained.meta.security.empty()- XPath
- not(exists(f:contained/*/f:meta/f:security))
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.id
- Path
- Patient.id
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Logical id of this artifact
- Definition
- The logical id of the resource, as used in the URL for the resource. Once assigned,
this value never changes.
- Base
- Resource.id [0..1]
- Comment
- The only time that a resource does not have an id is when it is being submitted to
the server using a create operation.
- Type
- http://hl7.org/fhirpath/System.String
Patient.meta Constrained
- Path
- Patient.meta
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Metadata about the resource
- Definition
- The metadata about the resource. This is content that is maintained by the infrastructure.
Changes to the content might not always be associated with version changes to the
resource.
- Base
- Resource.meta [0..1]
- Type
- Meta
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.implicitRules Constrained
- Path
- Patient.implicitRules
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- A set of rules under which this content was created
- Definition
- A reference to a set of rules that were followed when the resource was constructed,
and which must be understood when processing the content. Often, this is a reference
to an implementation guide that defines the special rules along with other profiles
etc.
- Base
- Resource.implicitRules [0..1]
- Comment
- Asserting this rule set restricts the content to be only understood by a limited set
of trading partners. This inherently limits the usefulness of the data in the long
term. However, the existing health eco-system is highly fractured, and not yet ready
to define, collect, and exchange data in a generally computable sense. Wherever possible,
implementers and/or specification writers should avoid using this element. Often,
when used, the URL is a reference to an implementation guide that defines these special
rules as part of it's narrative along with other profiles, value sets, etc.
- Type
- uri
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.language Binding Constrained
- Path
- Patient.language
- Cardinality
- 0..1
- Short Description
- Language of the resource content
- Definition
- The base language in which the resource is written.
- Base
- Resource.language [0..1]
- Comment
- Language is provided to support indexing and accessibility (typically, services such
as text to speech use the language tag). The html language tag in the narrative applies
to the narrative. The language tag on the resource may be used to specify the language
of other presentations generated from the data in the resource. Not all the content
has to be in the base language. The Resource.language should not be assumed to apply
to the narrative automatically. If a language is specified, it should it also be specified
on the div element in the html (see rules in HTML5 for information about the relationship
between xml:lang and the html lang attribute).
- Type
- code
- Binding
- Language(preferred) : A human language.
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.text Constrained
- Path
- Patient.text
- Cardinality
- 0..1
- Short Description
- Text summary of the resource, for human interpretation
- Definition
- A human-readable narrative that contains a summary of the resource and can be used
to represent the content of the resource to a human. The narrative need not encode
all the structured data, but is required to contain sufficient detail to make it "clinically
safe" for a human to just read the narrative. Resource definitions may define what
content should be represented in the narrative to ensure clinical safety.
- Base
- DomainResource.text [0..1]
- Comment
- Contained resources do not have narrative. Resources that are not contained SHOULD
have a narrative. In some cases, a resource may only have text with little or no additional
discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary
for data from legacy systems where information is captured as a "text blob" or where
text is additionally entered raw or narrated and encoded information is added later.
- Alias
- narrative, html, xhtml, display
- Type
- Narrative
Mapping
- rim:n/a
- rim:N/A
- rim:Act.text?
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contained
- Path
- Patient.contained
- Cardinality
- 0..*
- Short Description
- Contained, inline Resources
- Definition
- These resources do not have an independent existence apart from the resource that
contains them - they cannot be identified independently, and nor can they have their
own independent transaction scope.
- Base
- DomainResource.contained [0..*]
- Comment
- This should never be done when the content can be identified properly, as once identification
is lost, it is extremely difficult (and context dependent) to restore it again. Contained
resources may have profiles and tags In their meta elements, but SHALL NOT have security
labels.
- Alias
- inline resources, anonymous resources, contained resources
- Type
- Resource
Mapping
- rim:Entity. Role, or Act
- rim:N/A
Patient.extension Constrained
- Path
- Patient.extension
- Cardinality
- 1..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- May be used to represent additional information that is not part of the basic definition
of the resource. 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.
- Base
- DomainResource.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:nationality Constrained
- Path
- Patient.extension
- Cardinality
- 0..1
- Short Description
- Nationality
- Slice name
- nationality
- Definition
- The nationality of the patient.
- Base
- DomainResource.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityReliability Constrained
- Path
- Patient.extension
- Cardinality
- 1..1
- Short Description
- Reliabilility of the identity | Degré de fiabilité de l'identité
- Slice name
- identityReliability
- Definition
- Optional Extension Element - found in all resources.
- Base
- DomainResource.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityReliability.id
- Path
- Patient.extension.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.extension:identityReliability.extension Constrained
- Path
- Patient.extension.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityReliability.extension:identityReliability Constrained
- Path
- Patient.extension.extension
- Cardinality
- 0..1
- Short Description
- Fiabilité de l'identité
- Slice name
- identityReliability
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityReliability.extension:identityReliability.id
- Path
- Patient.extension.extension.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.extension:identityReliability.extension:identityReliability.extension Constrained
- Path
- Patient.extension.extension.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityReliability.extension:identityReliability.url Fixed value
- Path
- Patient.extension.extension.url
- Cardinality
- 1..1
- Representation
- Short Description
- identifies the meaning of the extension
- Definition
- Source of the definition for the extension code - a logical name or a URL.
- Base
- Extension.url [1..1]
- Comment
- The definition may point directly to a computable or human-readable definition of
the extensibility codes, or it may be a logical URI as declared in some other specification.
The definition SHALL be a URI for the Structure Definition defining the extension.
- Type
- http://hl7.org/fhirpath/System.String
- Fixed URI
- identityReliability
Mapping
Patient.extension:identityReliability.extension:identityReliability.value[x] Binding Constrained
- Path
- Patient.extension.extension.value[x]
- Cardinality
- 0..1
- Short Description
- Value of extension
- Definition
- Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html)
for a list).
- Base
- Extension.value[x] [0..1]
- Type
- Coding
- Binding
- (extensible) :
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:identityReliability.extension:validationDate Constrained
- Path
- Patient.extension.extension
- Cardinality
- 0..1
- Short Description
- Date de vérification de l'identité
- Slice name
- validationDate
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityReliability.extension:validationDate.id
- Path
- Patient.extension.extension.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.extension:identityReliability.extension:validationDate.extension Constrained
- Path
- Patient.extension.extension.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityReliability.extension:validationDate.url Fixed value
- Path
- Patient.extension.extension.url
- Cardinality
- 1..1
- Representation
- Short Description
- identifies the meaning of the extension
- Definition
- Source of the definition for the extension code - a logical name or a URL.
- Base
- Extension.url [1..1]
- Comment
- The definition may point directly to a computable or human-readable definition of
the extensibility codes, or it may be a logical URI as declared in some other specification.
The definition SHALL be a URI for the Structure Definition defining the extension.
- Type
- http://hl7.org/fhirpath/System.String
- Fixed URI
- validationDate
Mapping
Patient.extension:identityReliability.extension:validationDate.value[x] Constrained
- Path
- Patient.extension.extension.value[x]
- Cardinality
- 0..1
- Short Description
- Value of extension
- Definition
- Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html)
for a list).
- Base
- Extension.value[x] [0..1]
- Type
- date
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:identityReliability.extension:validationMode Constrained
- Path
- Patient.extension.extension
- Cardinality
- 0..1
- Short Description
- Mode de validation de l'identité (avec quelle pièce officielle?)
- Slice name
- validationMode
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityReliability.extension:validationMode.id
- Path
- Patient.extension.extension.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.extension:identityReliability.extension:validationMode.extension Constrained
- Path
- Patient.extension.extension.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityReliability.extension:validationMode.url Fixed value
- Path
- Patient.extension.extension.url
- Cardinality
- 1..1
- Representation
- Short Description
- identifies the meaning of the extension
- Definition
- Source of the definition for the extension code - a logical name or a URL.
- Base
- Extension.url [1..1]
- Comment
- The definition may point directly to a computable or human-readable definition of
the extensibility codes, or it may be a logical URI as declared in some other specification.
The definition SHALL be a URI for the Structure Definition defining the extension.
- Type
- http://hl7.org/fhirpath/System.String
- Fixed URI
- validationMode
Mapping
Patient.extension:identityReliability.extension:validationMode.value[x] Binding Constrained
- Path
- Patient.extension.extension.value[x]
- Cardinality
- 0..1
- Short Description
- Value of extension
- Definition
- Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html)
for a list).
- Base
- Extension.value[x] [0..1]
- Type
- Coding
- Binding
- (required) :
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:identityReliability.url Fixed value
- Path
- Patient.extension.url
- Cardinality
- 1..1
- Representation
- Short Description
- identifies the meaning of the extension
- Definition
- Source of the definition for the extension code - a logical name or a URL.
- Base
- Extension.url [1..1]
- Comment
- The definition may point directly to a computable or human-readable definition of
the extensibility codes, or it may be a logical URI as declared in some other specification.
The definition SHALL be a URI for the Structure Definition defining the extension.
- Type
- uri
- Fixed URI
- http://interopsante.org/fhir/StructureDefinition/FrPatientIdentReliability
Mapping
Patient.extension:identityReliability.value[x] Constrained
- Path
- Patient.extension.value[x]
- Cardinality
- 0..0
- Short Description
- Value of extension
- Definition
- Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html)
for a list).
- Base
- Extension.value[x] [0..1]
- Type
-
- base64Binary
- boolean
- canonical
- code
- date
- dateTime
- decimal
- id
- instant
- integer
- markdown
- oid
- positiveInt
- string
- time
- unsignedInt
- uri
- url
- uuid
- Address
- Age
- Annotation
- Attachment
- CodeableConcept
- Coding
- ContactPoint
- Count
- Distance
- Duration
- HumanName
- Identifier
- Money
- Period
- Quantity
- Range
- Ratio
- Reference
- SampledData
- Signature
- Timing
- ContactDetail
- Contributor
- DataRequirement
- Expression
- ParameterDefinition
- RelatedArtifact
- TriggerDefinition
- UsageContext
- Dosage
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:deathPlace Constrained
- Path
- Patient.extension
- Cardinality
- 0..*
- Short Description
- Optional Extensions Element
- Slice name
- deathPlace
- Definition
- Optional Extension Element - found in all resources.
- Base
- DomainResource.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:identityMethodCollection Constrained
- Path
- Patient.extension
- Cardinality
- 0..1
- Short Description
- Optional Extensions Element
- Slice name
- identityMethodCollection
- Definition
- Optional Extension Element - found in all resources.
- Base
- DomainResource.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:birthdateUpdateIndicator Constrained
- Path
- Patient.extension
- Cardinality
- 0..*
- Short Description
- Optional Extensions Element
- Slice name
- birthdateUpdateIndicator
- Definition
- Optional Extension Element - found in all resources.
- Base
- DomainResource.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:birthPlace Constrained
- Path
- Patient.extension
- Cardinality
- 0..1
- Short Description
- Place of Birth for patient
- Slice name
- birthPlace
- Definition
- The registered place of birth of the patient. A sytem may use the address.text if
they don't store the birthPlace address in discrete elements.
- Base
- DomainResource.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:birthPlace.id
- Path
- Patient.extension.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.extension:birthPlace.extension Constrained
- Path
- Patient.extension.extension
- Cardinality
- 0..0
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:birthPlace.url Fixed value
- Path
- Patient.extension.url
- Cardinality
- 1..1
- Representation
- Short Description
- identifies the meaning of the extension
- Definition
- Source of the definition for the extension code - a logical name or a URL.
- Base
- Extension.url [1..1]
- Comment
- The definition may point directly to a computable or human-readable definition of
the extensibility codes, or it may be a logical URI as declared in some other specification.
The definition SHALL be a URI for the Structure Definition defining the extension.
- Type
- http://hl7.org/fhirpath/System.String
- Fixed URI
- http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Mapping
Patient.extension:birthPlace.value[x] Constrained
- Path
- Patient.extension.value[x]
- Cardinality
- 1..1
- Short Description
- Value of extension
- Definition
- Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html)
for a list).
- Base
- Extension.value[x] [0..1]
- Type
- Address
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].id
- Path
- Patient.extension.value[x].id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.extension:birthPlace.value[x].extension Constrained
- Path
- Patient.extension.value[x].extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.extension:birthPlace.value[x].use Binding Constrained
- Path
- Patient.extension.value[x].use
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- home | work | temp | old | billing - purpose of this address
- Definition
- The purpose of this address.
- Base
- Address.use [0..1]
- Comment
- Applications can assume that an address is current unless it explicitly says that
it is temporary or old.
- Type
- code
- Binding
- AddressUse(required) : The use of an address.
Mapping
- rim:n/a
- v2:XAD.7
- rim:unique(./use)
- servd:./AddressPurpose
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].type Binding Constrained
- Path
- Patient.extension.value[x].type
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- postal | physical | both
- Definition
- Distinguishes between physical addresses (those you can visit) and mailing addresses
(e.g. PO Boxes and care-of addresses). Most addresses are both.
- Base
- Address.type [0..1]
- Comment
- The definition of Address states that "address is intended to describe postal addresses,
not physical locations". However, many applications track whether an address has a
dual purpose of being a location that can be visited as well as being a valid delivery
destination, and Postal addresses are often used as proxies for physical locations
(also see the [Location](location.html#) resource).
- Type
- code
- Binding
- AddressType(required) : The type of an address (physical / postal).
Mapping
- rim:n/a
- v2:XAD.18
- rim:unique(./use)
- vcard:address type parameter
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].text Constrained
- Path
- Patient.extension.value[x].text
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Text representation of the address
- Definition
- Specifies the entire address as it should be displayed e.g. on a postal label. This
may be provided instead of or as well as the specific parts.
- Base
- Address.text [0..1]
- Comment
- Can provide both a text representation and parts. Applications updating an address
SHALL ensure that when both text and parts are present, no content is included in
the text that isn't found in a part.
- Type
- string
Mapping
- rim:n/a
- v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim:./formatted
- vcard:address label parameter
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].line Constrained
- Path
- Patient.extension.value[x].line
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Street name, number, direction & P.O. Box etc.
- Definition
- This component contains the house number, apartment number, street name, street direction,
P.O. Box number, delivery hints, and similar address information.
- Base
- Address.line [0..*]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- string
Mapping
- rim:n/a
- v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address
than for a person address)
- rim:AD.part[parttype = AL]
- vcard:street
- servd:./StreetAddress (newline delimitted)
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].city Constrained
- Path
- Patient.extension.value[x].city
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Name of city, town etc.
- Definition
- The name of the city, town, suburb, village or other community or delivery center.
- Base
- Address.city [0..1]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Alias
- Municpality
- Type
- string
Mapping
- rim:n/a
- v2:XAD.3
- rim:AD.part[parttype = CTY]
- vcard:locality
- servd:./Jurisdiction
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].district Binding Constrained
- Path
- Patient.extension.value[x].district
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- District name (aka county)
- Definition
- The name of the administrative area (county).
- Base
- Address.district [0..1]
- Comment
- District is sometimes known as county, but in some regions 'county' is used in place
of city (municipality), so county name should be conveyed in city instead.
- Alias
- County
- Type
- string
- Binding
- (extensible) : Code COG town or country
Mapping
- rim:n/a
- v2:XAD.9
- rim:AD.part[parttype = CNT | CPA]
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].state Constrained
- Path
- Patient.extension.value[x].state
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Sub-unit of country (abbreviations ok)
- Definition
- Sub-unit of a country with limited sovereignty in a federally organized country. A
code may be used if codes are in common use (e.g. US 2 letter state codes).
- Base
- Address.state [0..1]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Alias
- Province, Territory
- Type
- string
Mapping
- rim:n/a
- v2:XAD.4
- rim:AD.part[parttype = STA]
- vcard:region
- servd:./Region
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].postalCode Constrained
- Path
- Patient.extension.value[x].postalCode
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Postal code for area
- Definition
- A postal code designating a region defined by the postal service.
- Base
- Address.postalCode [0..1]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Alias
- Zip
- Type
- string
Mapping
- rim:n/a
- v2:XAD.5
- rim:AD.part[parttype = ZIP]
- vcard:code
- servd:./PostalIdentificationCode
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].country Constrained
- Path
- Patient.extension.value[x].country
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Country (e.g. can be ISO 3166 2 or 3 letter code)
- Definition
- Country - a nation as commonly understood or generally accepted.
- Base
- Address.country [0..1]
- Comment
- ISO 3166 3 letter codes can be used in place of a human readable country name.
- Type
- string
Mapping
- rim:n/a
- v2:XAD.6
- rim:AD.part[parttype = CNT]
- vcard:country
- servd:./Country
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.extension:birthPlace.value[x].period Constrained
- Path
- Patient.extension.value[x].period
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Time period when address was/is in use
- Definition
- Time period when address was/is in use.
- Base
- Address.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:XAD.12 / XAD.13 + XAD.14
- rim:./usablePeriod[type="IVL<TS>"]
- servd:./StartDate and ./EndDate
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.modifierExtension Constrained
- Path
- Patient.modifierExtension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Extensions that cannot be ignored
- Definition
- May be used to represent additional information that is not part of the basic definition
of the resource and that modifies the understanding of the element that contains it
and/or the understanding of the containing element's descendants. Usually modifier
elements provide negation or qualification. 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 is allowed to define an extension, there is
a set of requirements that SHALL be met as part of the definition of the extension.
Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource
(including cannot change the meaning of modifierExtension itself).
- Base
- DomainResource.modifierExtension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.identifier Constrained
- Path
- Patient.identifier
- Cardinality
- 0..*
- Part of a summary ?
- true
- Slicing
-
- Descriminator type:value
- Descriminator path:type
- Rules:open
- Short Description
- National Health Identifier | Identifiant national de santé
- Definition
- An identifier for this patient.
- Base
- Patient.identifier [0..*]
- Type
- Identifier
Mapping
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows
URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.identifier
- v2:PID-3
- rim:id
- cda:.id
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIR Constrained
- Path
- Patient.identifier
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- The patient's health national identifier INS coming from the INSi teleservice| Identifiant
national de santé du patient INS provenant du téléservice INSi
- Slice name
- INS-NIR
- Definition
- patient's national identifier obtained by requesting the national patient identification
service (CNAM) | Identifiant NIR du patient récupéré à partir de l'interrogation du
service national d'identification des patients (CNAM)
- Base
- Patient.identifier [0..*]
- Type
- Identifier
Mapping
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows
URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.identifier
- v2:PID-3
- rim:id
- cda:.id
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIR.id
- Path
- Patient.identifier.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.identifier:INS-NIR.extension Constrained
- Path
- Patient.identifier.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.identifier:INS-NIR.use Fixed value Binding Constrained
- Path
- Patient.identifier.use
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- usual | official | temp | secondary | old (If known)
- Definition
- The purpose of this identifier.
- Base
- Identifier.use [0..1]
- Comment
- Applications can assume that an identifier is permanent unless it explicitly says
that it is temporary.
- Type
- code
- Fixed code
- official
- Binding
- IdentifierUse(required) : Identifies the purpose for this identifier, if known .
Mapping
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIR.type Binding Constrained
- Path
- Patient.identifier.type
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- Description of identifier
- Definition
- A coded type for the identifier that can be used to determine which identifier to
use for a specific purpose.
- Base
- Identifier.type [0..1]
- Comment
- 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.
- Type
- CodeableConcept
- Binding
- IdentifierType(extensible) : A coded type for an identifier that can be used to determine which identifier to use
for a specific purpose.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIR.system Fixed value Constrained
- Path
- Patient.identifier.system
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The namespace for the identifier value
- Definition
- Establishes the namespace for the value - that is, a OID that describes a set values
that are unique. | Autorité d'affectation des INS-NIR
- Base
- Identifier.system [0..1]
- Comment
- Identifier.system is always case sensitive.
- Type
- uri
- Fixed URI
- urn:oid:1.2.250.1.213.1.4.8
Mapping
- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIR.value Constrained
- Path
- Patient.identifier.value
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The value that is unique
- Definition
- The portion of the identifier typically relevant to the user and which is unique within
the context of the system.
- Base
- Identifier.value [0..1]
- Comment
- 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](extension-rendered-value.html).
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.
- Type
- string
Mapping
- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIR.period Constrained
- Path
- Patient.identifier.period
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Time period when id is/was valid for use
- Definition
- Time period during which identifier is/was valid for use.
- Base
- Identifier.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:INS-NIR.assigner Constrained
- Path
- Patient.identifier.assigner
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Organization that issued id (may be just text)
- Definition
- Organization that issued/manages the identifier.
- Base
- Identifier.assigner [0..1]
- Comment
- 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.
- Type
- Reference > http://hl7.org/fhir/StructureDefinition/Organization
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition
of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:INS-NIA Constrained
- Path
- Patient.identifier
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- INS-NIA
- Slice name
- INS-NIA
- Definition
- The temporary patient's health national identifier obtained by requesting the national
patient identification service (CNAM)| Identifiant national temporaire de santé du
patient obtenu par interrogation du téléservice INSi de la CNAM
- Base
- Patient.identifier [0..*]
- Type
- Identifier
Mapping
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows
URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.identifier
- v2:PID-3
- rim:id
- cda:.id
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIA.id
- Path
- Patient.identifier.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.identifier:INS-NIA.extension Constrained
- Path
- Patient.identifier.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.identifier:INS-NIA.use Fixed value Binding Constrained
- Path
- Patient.identifier.use
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- usual | official | temp | secondary | old (If known)
- Definition
- The purpose of this identifier.
- Base
- Identifier.use [0..1]
- Comment
- Applications can assume that an identifier is permanent unless it explicitly says
that it is temporary.
- Type
- code
- Fixed code
- temp
- Binding
- IdentifierUse(required) : Identifies the purpose for this identifier, if known .
Mapping
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIA.type Binding Constrained
- Path
- Patient.identifier.type
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- Description of identifier
- Definition
- A coded type for the identifier that can be used to determine which identifier to
use for a specific purpose.
- Base
- Identifier.type [0..1]
- Comment
- 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.
- Type
- CodeableConcept
- Binding
- IdentifierType(extensible) : A coded type for an identifier that can be used to determine which identifier to use
for a specific purpose.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIA.system Fixed value Constrained
- Path
- Patient.identifier.system
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The namespace for the identifier value
- Definition
- Establishes the namespace for the value - that is, a OID that describes a set values
that are unique. | Autorité d'affectation des INS-NIA
- Base
- Identifier.system [0..1]
- Comment
- Identifier.system is always case sensitive.
- Type
- uri
- Fixed URI
- urn:oid:1.2.250.1.213.1.4.9
Mapping
- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIA.value Constrained
- Path
- Patient.identifier.value
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The value that is unique
- Definition
- The portion of the identifier typically relevant to the user and which is unique within
the context of the system.
- Base
- Identifier.value [0..1]
- Comment
- 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](extension-rendered-value.html).
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.
- Type
- string
Mapping
- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-NIA.period Constrained
- Path
- Patient.identifier.period
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Time period when id is/was valid for use
- Definition
- Time period during which identifier is/was valid for use.
- Base
- Identifier.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:INS-NIA.assigner Constrained
- Path
- Patient.identifier.assigner
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Organization that issued id (may be just text)
- Definition
- Organization that issued/manages the identifier.
- Base
- Identifier.assigner [0..1]
- Comment
- 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.
- Type
- Reference > http://hl7.org/fhir/StructureDefinition/Organization
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition
of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:INS-C Constrained
- Path
- Patient.identifier
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- An identifier for this patient
- Slice name
- INS-C
- Definition
- Computed National Health Identifier | Identifiant National de Santé Calculé à partir
des éléments de la carte vitale
- Base
- Patient.identifier [0..*]
- Type
- Identifier
Mapping
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows
URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.identifier
- v2:PID-3
- rim:id
- cda:.id
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-C.id
- Path
- Patient.identifier.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.identifier:INS-C.extension Constrained
- Path
- Patient.identifier.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.identifier:INS-C.use Fixed value Binding Constrained
- Path
- Patient.identifier.use
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- usual | official | temp | secondary | old (If known)
- Definition
- The purpose of this identifier.
- Base
- Identifier.use [0..1]
- Comment
- Applications can assume that an identifier is permanent unless it explicitly says
that it is temporary.
- Type
- code
- Fixed code
- secondary
- Binding
- IdentifierUse(required) : Identifies the purpose for this identifier, if known .
Mapping
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-C.type Binding Constrained
- Path
- Patient.identifier.type
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- Description of identifier
- Definition
- Computed National Health Identifier | Identifiant National de Santé Calculé à partir
des éléments de la carte vitale
- Base
- Identifier.type [0..1]
- Comment
- 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.
- Type
- CodeableConcept
- Binding
- IdentifierType(extensible) : A coded type for an identifier that can be used to determine which identifier to use
for a specific purpose.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-C.system Fixed value Constrained
- Path
- Patient.identifier.system
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The namespace for the identifier value
- Definition
- Establishes the namespace for the value - that is, a URL that describes a set values
that are unique.
- Base
- Identifier.system [0..1]
- Comment
- Identifier.system is always case sensitive.
- Type
- uri
- Fixed URI
- urn:oid:1.2.250.1.213.1.4.2
Mapping
- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-C.value Constrained
- Path
- Patient.identifier.value
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The value that is unique
- Definition
- The portion of the identifier typically relevant to the user and which is unique within
the context of the system.
- Base
- Identifier.value [0..1]
- Comment
- 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](extension-rendered-value.html).
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.
- Type
- string
Mapping
- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:INS-C.period Constrained
- Path
- Patient.identifier.period
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Time period when id is/was valid for use
- Definition
- Time period during which identifier is/was valid for use.
- Base
- Identifier.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:INS-C.assigner Constrained
- Path
- Patient.identifier.assigner
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Organization that issued id (may be just text)
- Definition
- Organization that issued/manages the identifier.
- Base
- Identifier.assigner [0..1]
- Comment
- 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.
- Type
- Reference > http://hl7.org/fhir/StructureDefinition/Organization
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition
of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:NDP Constrained
- Path
- Patient.identifier
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- French pharmaceutical Record Identifier | Numéro de Dossier Pharmaceutique français
- Slice name
- NDP
- Definition
- Pharmaceutical Record Identifier | Numéro de Dossier Pharmaceutique
- Base
- Patient.identifier [0..*]
- Type
- Identifier
Mapping
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows
URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.identifier
- v2:PID-3
- rim:id
- cda:.id
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:NDP.id
- Path
- Patient.identifier.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.identifier:NDP.extension Constrained
- Path
- Patient.identifier.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.identifier:NDP.use Fixed value Binding Constrained
- Path
- Patient.identifier.use
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- usual | official | temp | secondary | old (If known)
- Definition
- The purpose of this identifier.
- Base
- Identifier.use [0..1]
- Comment
- Applications can assume that an identifier is permanent unless it explicitly says
that it is temporary.
- Type
- code
- Fixed code
- secondary
- Binding
- IdentifierUse(required) : Identifies the purpose for this identifier, if known .
Mapping
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:NDP.type Binding Constrained
- Path
- Patient.identifier.type
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- Description of identifier
- Definition
- A coded type for the identifier that can be used to determine which identifier to
use for a specific purpose.
- Base
- Identifier.type [0..1]
- Comment
- 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.
- Type
- CodeableConcept
- Binding
- IdentifierType(extensible) : A coded type for an identifier that can be used to determine which identifier to use
for a specific purpose.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:NDP.system Fixed value Constrained
- Path
- Patient.identifier.system
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The namespace for the identifier value
- Definition
- Establishes the namespace for the value - that is, a URL that describes a set values
that are unique.
- Base
- Identifier.system [0..1]
- Comment
- Identifier.system is always case sensitive.
- Type
- uri
- Fixed URI
- urn:oid:1.2.250.1.176.1.2
Mapping
- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:NDP.value Constrained
- Path
- Patient.identifier.value
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The value that is unique
- Definition
- The portion of the identifier typically relevant to the user and which is unique within
the context of the system.
- Base
- Identifier.value [0..1]
- Comment
- 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](extension-rendered-value.html).
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.
- Type
- string
Mapping
- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:NDP.period Constrained
- Path
- Patient.identifier.period
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Time period when id is/was valid for use
- Definition
- Time period during which identifier is/was valid for use.
- Base
- Identifier.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:NDP.assigner Constrained
- Path
- Patient.identifier.assigner
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Organization that issued id (may be just text)
- Definition
- Organization that issued/manages the identifier.
- Base
- Identifier.assigner [0..1]
- Comment
- 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.
- Type
- Reference > http://hl7.org/fhir/StructureDefinition/Organization
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition
of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:PI Constrained
- Path
- Patient.identifier
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Hospital assigned patient identifier | IPP
- Slice name
- PI
- Definition
- Hospital assigned patient identifier | IPP
- Base
- Patient.identifier [0..*]
- Type
- Identifier
Mapping
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows
URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.identifier
- v2:PID-3
- rim:id
- cda:.id
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:PI.id
- Path
- Patient.identifier.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.identifier:PI.extension Constrained
- Path
- Patient.identifier.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.identifier:PI.use Fixed value Binding Constrained
- Path
- Patient.identifier.use
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- usual | official | temp | secondary | old (If known)
- Definition
- The purpose of this identifier.
- Base
- Identifier.use [0..1]
- Comment
- Applications can assume that an identifier is permanent unless it explicitly says
that it is temporary.
- Type
- code
- Fixed code
- usual
- Binding
- IdentifierUse(required) : Identifies the purpose for this identifier, if known .
Mapping
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:PI.type Binding Constrained
- Path
- Patient.identifier.type
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- Description of identifier
- Definition
- A coded type for the identifier that can be used to determine which identifier to
use for a specific purpose.
- Base
- Identifier.type [0..1]
- Comment
- 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.
- Type
- CodeableConcept
- Binding
- IdentifierType(extensible) : A coded type for an identifier that can be used to determine which identifier to use
for a specific purpose.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:PI.system Constrained
- Path
- Patient.identifier.system
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The namespace for the identifier value
- Definition
- Establishes the namespace for the value - that is, a URL that describes a set values
that are unique.
- Base
- Identifier.system [0..1]
- Comment
- Identifier.system is always case sensitive.
- Type
- uri
Mapping
- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:PI.value Constrained
- Path
- Patient.identifier.value
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The value that is unique
- Definition
- The portion of the identifier typically relevant to the user and which is unique within
the context of the system.
- Base
- Identifier.value [0..1]
- Comment
- 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](extension-rendered-value.html).
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.
- Type
- string
Mapping
- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:PI.period Constrained
- Path
- Patient.identifier.period
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Time period when id is/was valid for use
- Definition
- Time period during which identifier is/was valid for use.
- Base
- Identifier.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:PI.assigner Constrained
- Path
- Patient.identifier.assigner
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Organization that issued id (may be just text)
- Definition
- Organization that issued/manages the identifier.
- Base
- Identifier.assigner [0..1]
- Comment
- 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.
- Type
- Reference > http://hl7.org/fhir/StructureDefinition/Organization
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition
of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:RRI Constrained
- Path
- Patient.identifier
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Regional Registry ID | Identifiant régional
- Slice name
- RRI
- Definition
- Regional Registry ID | Identifiant régional
- Base
- Patient.identifier [0..*]
- Type
- Identifier
Mapping
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows
URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.identifier
- v2:PID-3
- rim:id
- cda:.id
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:RRI.id
- Path
- Patient.identifier.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.identifier:RRI.extension Constrained
- Path
- Patient.identifier.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.identifier:RRI.use Fixed value Binding Constrained
- Path
- Patient.identifier.use
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- usual | official | temp | secondary | old (If known)
- Definition
- The purpose of this identifier.
- Base
- Identifier.use [0..1]
- Comment
- Applications can assume that an identifier is permanent unless it explicitly says
that it is temporary.
- Type
- code
- Fixed code
- secondary
- Binding
- IdentifierUse(required) : Identifies the purpose for this identifier, if known .
Mapping
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:RRI.type Binding Constrained
- Path
- Patient.identifier.type
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- Description of identifier
- Definition
- A coded type for the identifier that can be used to determine which identifier to
use for a specific purpose.
- Base
- Identifier.type [0..1]
- Comment
- 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.
- Type
- CodeableConcept
- Binding
- IdentifierType(extensible) : A coded type for an identifier that can be used to determine which identifier to use
for a specific purpose.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:RRI.system Constrained
- Path
- Patient.identifier.system
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The namespace for the identifier value
- Definition
- Establishes the namespace for the value - that is, a URL that describes a set values
that are unique.
- Base
- Identifier.system [0..1]
- Comment
- Identifier.system is always case sensitive.
- Type
- uri
Mapping
- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:RRI.value Constrained
- Path
- Patient.identifier.value
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The value that is unique
- Definition
- The portion of the identifier typically relevant to the user and which is unique within
the context of the system.
- Base
- Identifier.value [0..1]
- Comment
- 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](extension-rendered-value.html).
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.
- Type
- string
Mapping
- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.identifier:RRI.period Constrained
- Path
- Patient.identifier.period
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Time period when id is/was valid for use
- Definition
- Time period during which identifier is/was valid for use.
- Base
- Identifier.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.identifier:RRI.assigner Constrained
- Path
- Patient.identifier.assigner
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Organization that issued id (may be just text)
- Definition
- Organization that issued/manages the identifier.
- Base
- Identifier.assigner [0..1]
- Comment
- 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.
- Type
- Reference > http://hl7.org/fhir/StructureDefinition/Organization
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition
of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.active Constrained
- Path
- Patient.active
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Whether this patient's record is in active use
- Definition
- Whether this patient record is in active use.
Many systems use this property to mark as non-current patients, such as those that
have not been seen for a period of time based on an organization's business rules.
It is often used to filter patient lists to exclude inactive patients
Deceased patients may also be marked as inactive for the same reasons, but may be
active for some time after death.
- Base
- Patient.active [0..1]
- Comment
- If a record is inactive, and linked to an active record, then future patient/record
updates should occur on the other patient.
- Type
- boolean
Mapping
- rim:n/a
- w5:FiveWs.status
- rim:statusCode
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name Constrained
- Path
- Patient.name
- Cardinality
- 1..*
- Part of a summary ?
- true
- Slicing
-
- Descriminator type:value
- Descriminator path:use
- Rules:open
- Short Description
- Name of a human - parts and usage
- Definition
- A human's name with the ability to identify parts and usage.
- Base
- Patient.name [0..*]
- Comment
- Names may be changed, or repudiated, or people may have different names in different
contexts. Names may be divided into parts of different type that have variable significance
depending on context, though the division into parts does not always matter. With
personal names, the different parts might or might not be imbued with some implicit
meaning; various cultures associate different importance with the name parts and the
degree to which systems must care about name parts around the world varies widely.
- Type
- HumanName
Mapping
- rim:n/a
- v2:XPN
- rim:EN (actually, PN)
- servd:ProviderName
- v2:PID-5, PID-9
- rim:name
- cda:.patient.name
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:usualName Constrained
- Path
- Patient.name
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Name of a human | Nom utilisé
- Slice name
- usualName
- Definition
- A human's name with the ability to identify parts and usage | Le nom utilisé (usual)
n’est transmis que s’il est défini (par exemple nom marital du conjoint).
- Base
- Patient.name [0..*]
- Comment
- Names may be changed, or repudiated, or people may have different names in different
contexts. Names may be divided into parts of different type that have variable significance
depending on context, though the division into parts does not always matter. With
personal names, the different parts might or might not be imbued with some implicit
meaning; various cultures associate different importance with the name parts and the
degree to which systems must care about name parts around the world varies widely.
- Type
- HumanName
Mapping
- rim:n/a
- v2:XPN
- rim:EN (actually, PN)
- servd:ProviderName
- v2:PID-5, PID-9
- rim:name
- cda:.patient.name
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:usualName.id
- Path
- Patient.name.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.name:usualName.extension Constrained
- Path
- Patient.name.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.name:usualName.extension:assemblyOrder Constrained
- Path
- Patient.name.extension
- Cardinality
- 0..*
- Short Description
- Preferred display order of name parts
- Slice name
- assemblyOrder
- Definition
- A code that represents the preferred display order of the components of this human
name.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.name:usualName.use Fixed value Binding Constrained
- Path
- Patient.name.use
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- usual | official | temp | nickname | anonymous | old | maiden
- Definition
- Identifies the purpose for this name.
- Base
- HumanName.use [0..1]
- Comment
- Applications can assume that a name is current unless it explicitly says that it is
temporary or old.
- Type
- code
- Fixed code
- usual
- Binding
- NameUse(required) : The use of a human name.
Mapping
- rim:n/a
- v2:XPN.7, but often indicated by which field contains the name
- rim:unique(./use)
- servd:./NamePurpose
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:usualName.text Constrained
- Path
- Patient.name.text
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Text representation of the full name
- Definition
- Specifies the entire name as it should be displayed e.g. on an application UI. This
may be provided instead of or as well as the specific parts.
- Base
- HumanName.text [0..1]
- Comment
- Can provide both a text representation and parts. Applications updating a name SHALL
ensure that when both text and parts are present, no content is included in the text
that isn't found in a part.
- Type
- string
Mapping
- rim:n/a
- v2:implied by XPN.11
- rim:./formatted
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:usualName.family Constrained
- Path
- Patient.name.family
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Family name (often called 'Surname')
- Definition
- The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the
family name of a son is the first name of his father.
- Base
- HumanName.family [0..1]
- Comment
- Family Name may be decomposed into specific parts using extensions (de, nl, es related
cultures).
- Alias
- surname
- Type
- string
Mapping
- rim:n/a
- v2:XPN.1/FN.1
- rim:./part[partType = FAM]
- servd:./FamilyName
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:usualName.given Constrained
- Path
- Patient.name.given
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Given names (not always 'first'). Includes middle names
- Definition
- Given name.
- Base
- HumanName.given [0..*]
- Comment
- If only initials are recorded, they may be used in place of the full name parts. Initials
may be separated into multiple given names but often aren't due to paractical limitations.
This element is not called "first name" since given names do not always come first.
- Alias
- first name, middle name
- Type
- string
Mapping
- rim:n/a
- v2:XPN.2 + XPN.3
- rim:./part[partType = GIV]
- servd:./GivenNames
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:usualName.prefix Binding Constrained
- Path
- Patient.name.prefix
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Parts that come before the name
- Definition
- Part of the name that is acquired as a title due to academic, legal, employment or
nobility status, etc. and that appears at the start of the name.
- Base
- HumanName.prefix [0..*]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- string
- Binding
- (extensible) : Civilités des personnes physiques du RASS
Mapping
- rim:n/a
- v2:XPN.5
- rim:./part[partType = PFX]
- servd:./TitleCode
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:usualName.suffix Binding Constrained
- Path
- Patient.name.suffix
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- jeu de valeurs pour spécifier le titre de la personne
- Definition
- Part of the name that is acquired as a title due to academic, legal, employment or
nobility status, etc. and that appears at the end of the name.
- Base
- HumanName.suffix [0..*]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- string
- Binding
- (extensible) : Civilités d'exercice d'un professionnel du RASS
Mapping
- rim:n/a
- v2:XPN/4
- rim:./part[partType = SFX]
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:usualName.period Constrained
- Path
- Patient.name.period
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Time period when name was/is in use
- Definition
- Indicates the period of time when this name was valid for the named person.
- Base
- HumanName.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:XPN.13 + XPN.14
- rim:./usablePeriod[type="IVL<TS>"]
- servd:./StartDate and ./EndDate
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.name:officialName Constrained
- Path
- Patient.name
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Name of a human | Nom de naissance
- Slice name
- officialName
- Definition
- A human's name with the ability to identify parts and usage | Le nom de naissance
(official) est obligatoire dans le cas où l’on véhicule l’INS et que l’identité est
qualifiée (celui-ci ne doit pas être altéré).
- Base
- Patient.name [0..*]
- Comment
- Names may be changed, or repudiated, or people may have different names in different
contexts. Names may be divided into parts of different type that have variable significance
depending on context, though the division into parts does not always matter. With
personal names, the different parts might or might not be imbued with some implicit
meaning; various cultures associate different importance with the name parts and the
degree to which systems must care about name parts around the world varies widely.
- Type
- HumanName
Mapping
- rim:n/a
- v2:XPN
- rim:EN (actually, PN)
- servd:ProviderName
- v2:PID-5, PID-9
- rim:name
- cda:.patient.name
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:officialName.id
- Path
- Patient.name.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.name:officialName.extension Constrained
- Path
- Patient.name.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.name:officialName.extension:assemblyOrder Constrained
- Path
- Patient.name.extension
- Cardinality
- 0..*
- Short Description
- Preferred display order of name parts
- Slice name
- assemblyOrder
- Definition
- A code that represents the preferred display order of the components of this human
name.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.name:officialName.use Fixed value Binding Constrained
- Path
- Patient.name.use
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- usual | official | temp | nickname | anonymous | old | maiden
- Definition
- Identifies the purpose for this name.
- Base
- HumanName.use [0..1]
- Comment
- Applications can assume that a name is current unless it explicitly says that it is
temporary or old.
- Type
- code
- Fixed code
- official
- Binding
- NameUse(required) : The use of a human name.
Mapping
- rim:n/a
- v2:XPN.7, but often indicated by which field contains the name
- rim:unique(./use)
- servd:./NamePurpose
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:officialName.text Constrained
- Path
- Patient.name.text
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Text representation of the full name
- Definition
- Specifies the entire name as it should be displayed e.g. on an application UI. This
may be provided instead of or as well as the specific parts.
- Base
- HumanName.text [0..1]
- Comment
- Can provide both a text representation and parts. Applications updating a name SHALL
ensure that when both text and parts are present, no content is included in the text
that isn't found in a part.
- Type
- string
Mapping
- rim:n/a
- v2:implied by XPN.11
- rim:./formatted
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:officialName.family Constrained
- Path
- Patient.name.family
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- Family name (often called 'Surname')
- Definition
- The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the
family name of a son is the first name of his father.
- Base
- HumanName.family [0..1]
- Comment
- Family Name may be decomposed into specific parts using extensions (de, nl, es related
cultures).
- Alias
- surname
- Type
- string
Mapping
- rim:n/a
- v2:XPN.1/FN.1
- rim:./part[partType = FAM]
- servd:./FamilyName
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:officialName.given Constrained
- Path
- Patient.name.given
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- Given names (not always 'first'). Includes middle names
- Definition
- Given name.
- Base
- HumanName.given [0..*]
- Comment
- If only initials are recorded, they may be used in place of the full name parts. Initials
may be separated into multiple given names but often aren't due to paractical limitations.
This element is not called "first name" since given names do not always come first.
- Alias
- first name, middle name
- Type
- string
Mapping
- rim:n/a
- v2:XPN.2 + XPN.3
- rim:./part[partType = GIV]
- servd:./GivenNames
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:officialName.prefix Binding Constrained
- Path
- Patient.name.prefix
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Parts that come before the name
- Definition
- Part of the name that is acquired as a title due to academic, legal, employment or
nobility status, etc. and that appears at the start of the name.
- Base
- HumanName.prefix [0..*]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- string
- Binding
- (extensible) : Civilités des personnes physiques du RASS
Mapping
- rim:n/a
- v2:XPN.5
- rim:./part[partType = PFX]
- servd:./TitleCode
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:officialName.suffix Binding Constrained
- Path
- Patient.name.suffix
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- jeu de valeurs pour spécifier le titre de la personne
- Definition
- Part of the name that is acquired as a title due to academic, legal, employment or
nobility status, etc. and that appears at the end of the name.
- Base
- HumanName.suffix [0..*]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- string
- Binding
- (extensible) : Civilités d'exercice d'un professionnel du RASS
Mapping
- rim:n/a
- v2:XPN/4
- rim:./part[partType = SFX]
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.name:officialName.period Constrained
- Path
- Patient.name.period
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Time period when name was/is in use
- Definition
- Indicates the period of time when this name was valid for the named person.
- Base
- HumanName.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:XPN.13 + XPN.14
- rim:./usablePeriod[type="IVL<TS>"]
- servd:./StartDate and ./EndDate
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.telecom Constrained
- Path
- Patient.telecom
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Details of a Technology mediated contact point (phone, fax, email, etc.)
- Definition
- Details for all kinds of technology mediated contact points for a person or organization,
including telephone, email, etc.
- Base
- Patient.telecom [0..*]
- Comment
- A Patient may have multiple ways to be contacted with different uses or applicable
periods. May need to have options for contacting the person urgently and also to
help with identification. The address might not go directly to the individual, but
may reach another party that is able to proxy for the patient (i.e. home phone, or
pet owner's phone).
- Type
- ContactPoint
Mapping
- rim:n/a
- v2:XTN
- rim:TEL
- servd:ContactPoint
- v2:PID-13, PID-14, PID-40
- rim:telecom
- cda:.telecom
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorcpt-2
- Description
- A system is required if a value is provided.
- Expression
value.empty() or system.exists()- XPath
- not(exists(f:value)) or exists(f:system)
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.gender Binding Constrained
- Path
- Patient.gender
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- male | female | other | unknown
- Definition
- French patient's gender checked with the INSi teleservice | Genre du patient. Dans
le cas d'une identité récupérée par le téléservice INSi, les valeurs sont M ou F
- Base
- Patient.gender [0..1]
- Comment
- The gender might not match the biological sex as determined by genetics or the individual's
preferred identification. Note that for both humans and particularly animals, there
are other legitimate possibilities than male and female, though the vast majority
of systems and contexts only support male and female. Systems providing decision
support or enforcing business rules should ideally do this on the basis of Observations
dealing with the specific sex or gender aspect of interest (anatomical, chromosomal,
social, etc.) However, because these observations are infrequently recorded, defaulting
to the administrative gender is common practice. Where such defaulting occurs, rule
enforcement should allow for the variation between administrative and biological,
chromosomal and other gender aspects. For example, an alert about a hysterectomy
on a male should be handled as a warning or overridable error, not a "hard" error.
See the Patient Gender and Sex section for additional information about communicating
patient gender and sex.
- Type
- code
- Binding
- AdministrativeGender(required) : The gender of a person used for administrative purposes.
Mapping
- rim:n/a
- v2:PID-8
- rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda:.patient.administrativeGenderCode
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.birthDate Constrained
- Path
- Patient.birthDate
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The date of birth for the french patient checked with the INSitelservice | Date de
naissance du patient. Dans le cas d'une identité récupérée du téléservice INSi, la
date de naissance est modifiée selon les règles du RNIV dans le cas de dates exceptionnelles.
- Definition
- The date of birth for the french patient checked with the INSitelservice | Date de
naissance du patient. Dans le cas d'une identité récupérée du téléservice INSi, la
date de naissance est modifiée selon les règles du RNIV dans le cas de dates exceptionnelles.
- Base
- Patient.birthDate [0..1]
- Comment
- At least an estimated year should be provided as a guess if the real DOB is unknown
There is a standard extension "patient-birthTime" available that should be used where
Time is required (such as in maternity/infant care systems).
- Type
- date
Mapping
- rim:n/a
- v2:PID-7
- rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
- cda:.patient.birthTime
- loinc:21112-8
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.deceased[x] Constrained
- Path
- Patient.deceased[x]
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Indicates if the individual is deceased or not
- Definition
- Indicates if the individual is deceased or not.
- Base
- Patient.deceased[x] [0..1]
- Comment
- If there's no value in the instance, it means there is no statement on whether or
not the individual is deceased. Most systems will interpret the absence of a value
as a sign of the person being alive.
- Type
-
Mapping
- rim:n/a
- v2:PID-30 (bool) and PID-29 (datetime)
- rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM
and determinerCode=INSTANCE]/deceasedTime
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.address Constrained
- Path
- Patient.address
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- An address expressed using postal conventions (as opposed to GPS or other location
definition formats)
- Definition
- An address expressed using postal conventions (as opposed to GPS or other location
definition formats). This data type may be used to convey addresses for use in delivering
mail as well as for visiting locations which might not be valid for mail delivery.
There are a variety of postal address formats defined around the world.
- Base
- Patient.address [0..*]
- Comment
- Note: address is intended to describe postal addresses for administrative purposes,
not to describe absolute geographical coordinates. Postal addresses are often used
as proxies for physical locations (also see the [Location](location.html#) resource).
- Type
- Address
Mapping
- rim:n/a
- v2:XAD
- rim:AD
- servd:Address
- v2:PID-11
- rim:addr
- cda:.addr
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.maritalStatus Binding Constrained
- Path
- Patient.maritalStatus
- Cardinality
- 0..1
- Short Description
- Marital (civil) status of a patient
- Definition
- This field contains a patient's most recent marital (civil) status.
- Base
- Patient.maritalStatus [0..1]
- Comment
- Not all terminology uses fit this general pattern. In some cases, models should not
use CodeableConcept and use Coding directly and provide their own structure for managing
text, codings, translations and the relationship between elements and pre- and post-coordination.
- Type
- CodeableConcept
- Binding
- MaritalStatus(extensible) : The domestic partnership status of a person.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:PID-16
- rim:player[classCode=PSN]/maritalStatusCode
- cda:.patient.maritalStatusCode
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.multipleBirth[x] Constrained
- Path
- Patient.multipleBirth[x]
- Cardinality
- 0..1
- Short Description
- Whether patient is part of a multiple birth
- Definition
- Indicates whether the patient is part of a multiple (boolean) or indicates the actual
birth order (integer).
- Base
- Patient.multipleBirth[x] [0..1]
- Comment
- Where the valueInteger is provided, the number is the birth number in the sequence.
E.g. The middle birth in triplets would be valueInteger=2 and the third born would
have valueInteger=3 If a boolean value was provided for this triplets example, then
all 3 patient records would have valueBoolean=true (the ordering is not indicated).
- Type
-
Mapping
- rim:n/a
- v2:PID-24 (bool), PID-25 (integer)
- rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM
and determinerCode=INSTANCE]/multipleBirthOrderNumber
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.photo Constrained
- Path
- Patient.photo
- Cardinality
- 0..*
- Short Description
- Image of the patient
- Definition
- Image of the patient.
- Base
- Patient.photo [0..*]
- Comment
- Guidelines:
* Use id photos, not clinical photos.
* Limit dimensions to thumbnail.
* Keep byte count low to ease resource updates.
- Type
- Attachment
Mapping
- rim:n/a
- v2:ED/RP
- rim:ED
- v2:OBX-5 - needs a profile
- rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- erroratt-1
- Description
- If the Attachment has data, it SHALL have a contentType
- Expression
data.empty() or contentType.exists()- XPath
- not(exists(f:data)) or exists(f:contentType)
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.contact Constrained
- Path
- Patient.contact
- Cardinality
- 0..*
- Short Description
- A contact party (e.g. guardian, partner, friend) for the patient
- Definition
- A contact party (e.g. guardian, partner, friend) for the patient.
- Base
- Patient.contact [0..*]
- Comment
- Contact covers all kinds of contact parties: family members, business contacts, guardians,
caregivers. Not applicable to register pedigree and family ties beyond use of having
contact.
- Type
- BackboneElement
Mapping
- rim:n/a
- rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorpat-1
- Description
- SHALL at least contain a contact's details or a reference to an organization
- Expression
name.exists() or telecom.exists() or address.exists() or organization.exists()- XPath
- exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.contact.id
- Path
- Patient.contact.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.contact.extension Constrained
- Path
- Patient.contact.extension
- Cardinality
- 1..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.contact.extension:contactIdentifier Constrained
- Path
- Patient.contact.extension
- Cardinality
- 1..*
- Short Description
- Contact identifier in the patient resource | Identifiant de contact dans la ressource
Patient
- Slice name
- contactIdentifier
- Definition
- Optional Extension Element - found in all resources.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
- Path
- Patient.contact.extension
- Cardinality
- 0..1
- Short Description
- Comment on a dataElement | Commentaire sur un dataElement
- Slice name
- comment
- Definition
- Optional Extension Element - found in all resources.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.contact.modifierExtension Constrained
- Path
- Patient.contact.modifierExtension
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Extensions that cannot be ignored even if unrecognized
- Definition
- May be used to represent additional information that is not part of the basic definition
of the element and that modifies the understanding of the element in which it is contained
and/or the understanding of the containing element's descendants. Usually modifier
elements provide negation or qualification. 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. Applications processing
a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource
(including cannot change the meaning of modifierExtension itself).
- Base
- BackboneElement.modifierExtension [0..*]
- Comment
- 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.
- Alias
- extensions, user content, modifiers
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.contact.relationship Binding Constrained
- Path
- Patient.contact.relationship
- Cardinality
- 1..1
- Slicing
-
- Descriminator type:value
- Descriminator path:coding.system
- Rules:open
- Short Description
- The kind of relationship
- Definition
- The nature of the relationship between the patient and the contact person.
- Base
- Patient.contact.relationship [0..*]
- Comment
- Not all terminology uses fit this general pattern. In some cases, models should not
use CodeableConcept and use Coding directly and provide their own structure for managing
text, codings, translations and the relationship between elements and pre- and post-coordination.
- Type
- CodeableConcept
- Binding
- ContactRelationship(extensible) : The nature of the relationship between a patient and a contact person for that patient.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:NK1-7, NK1-3
- rim:code
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RolePerson Binding Constrained
- Path
- Patient.contact.relationship
- Cardinality
- 0..1
- Short Description
- The kind of relationship
- Slice name
- RolePerson
- Definition
- The nature of the relationship between the patient and the contact person.
- Base
- Patient.contact.relationship [0..*]
- Comment
- Not all terminology uses fit this general pattern. In some cases, models should not
use CodeableConcept and use Coding directly and provide their own structure for managing
text, codings, translations and the relationship between elements and pre- and post-coordination.
- Type
- CodeableConcept
- Binding
- ContactRelationship(extensible) : The nature of the relationship between a patient and a contact person for that patient.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:NK1-7, NK1-3
- rim:code
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RolePerson.id
- Path
- Patient.contact.relationship.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.contact.relationship:RolePerson.extension Constrained
- Path
- Patient.contact.relationship.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.contact.relationship:RolePerson.coding Constrained
- Path
- Patient.contact.relationship.coding
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Code defined by a terminology system
- Definition
- A reference to a code defined by a terminology system.
- Base
- CodeableConcept.coding [0..*]
- Comment
- 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.
- Type
- Coding
Mapping
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- v2:C*E.1-8, C*E.10-22
- rim:union(., ./translation)
- orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RolePerson.coding.id
- Path
- Patient.contact.relationship.coding.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.contact.relationship:RolePerson.coding.extension Constrained
- Path
- Patient.contact.relationship.coding.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.contact.relationship:RolePerson.coding.system Fixed value Constrained
- Path
- Patient.contact.relationship.coding.system
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Identity of the terminology system
- Definition
- The identification of the code system that defines the meaning of the symbol in the
code.
- Base
- Coding.system [0..1]
- Comment
- 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.
- Type
- uri
- Fixed URI
- https://mos.esante.gouv.fr/NOS/TRE_R260-HL7RoleClass/FHIR/TRE-R260-HL7RoleClass
Mapping
- rim:n/a
- v2:C*E.3
- rim:./codeSystem
- orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RolePerson.coding.version Constrained
- Path
- Patient.contact.relationship.coding.version
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Version of the system - if relevant
- Definition
- 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.
- Base
- Coding.version [0..1]
- Comment
- 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.
- Type
- string
Mapping
- rim:n/a
- v2:C*E.7
- rim:./codeSystemVersion
- orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RolePerson.coding.code Constrained
- Path
- Patient.contact.relationship.coding.code
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Symbol in syntax defined by the system
- Definition
- 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).
- Base
- Coding.code [0..1]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- code
Mapping
- rim:n/a
- v2:C*E.1
- rim:./code
- orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RolePerson.coding.display Constrained
- Path
- Patient.contact.relationship.coding.display
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Representation defined by the system
- Definition
- A representation of the meaning of the code in the system, following the rules of
the system.
- Base
- Coding.display [0..1]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- string
Mapping
- rim:n/a
- v2:C*E.2 - but note this is not well followed
- rim:CV.displayName
- orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RolePerson.coding.userSelected Constrained
- Path
- Patient.contact.relationship.coding.userSelected
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- If this coding was chosen directly by the user
- Definition
- Indicates that this coding was chosen by a user directly - e.g. off a pick list of
available items (codes or displays).
- Base
- Coding.userSelected [0..1]
- Comment
- 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.
- Type
- boolean
Mapping
- rim:n/a
- v2:Sometimes implied by being first
- rim:CD.codingRationale
- orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected
fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map;
fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source
"true"; fhir:target dt:CDCoding.codingRationale\#O ]
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RolePerson.text Constrained
- Path
- Patient.contact.relationship.text
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Plain text representation of the concept
- Definition
- 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.
- Base
- CodeableConcept.text [0..1]
- Comment
- Very often the text is the same as a displayName of one of the codings.
- Type
- string
Mapping
- rim:n/a
- v2:C*E.9. But note many systems use C*E.2 for this
- rim:./originalText[mediaType/code="text/plain"]/data
- orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RelatedPerson Binding Constrained
- Path
- Patient.contact.relationship
- Cardinality
- 0..1
- Short Description
- The kind of relationship
- Slice name
- RelatedPerson
- Definition
- The nature of the relationship between the patient and the contact person.
- Base
- Patient.contact.relationship [0..*]
- Comment
- Not all terminology uses fit this general pattern. In some cases, models should not
use CodeableConcept and use Coding directly and provide their own structure for managing
text, codings, translations and the relationship between elements and pre- and post-coordination.
- Type
- CodeableConcept
- Binding
- ContactRelationship(extensible) : The nature of the relationship between a patient and a contact person for that patient.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:NK1-7, NK1-3
- rim:code
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RelatedPerson.id
- Path
- Patient.contact.relationship.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.contact.relationship:RelatedPerson.extension Constrained
- Path
- Patient.contact.relationship.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.contact.relationship:RelatedPerson.coding Constrained
- Path
- Patient.contact.relationship.coding
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Code defined by a terminology system
- Definition
- A reference to a code defined by a terminology system.
- Base
- CodeableConcept.coding [0..*]
- Comment
- 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.
- Type
- Coding
Mapping
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- v2:C*E.1-8, C*E.10-22
- rim:union(., ./translation)
- orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RelatedPerson.coding.id
- Path
- Patient.contact.relationship.coding.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.contact.relationship:RelatedPerson.coding.extension Constrained
- Path
- Patient.contact.relationship.coding.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.contact.relationship:RelatedPerson.coding.system Fixed value Constrained
- Path
- Patient.contact.relationship.coding.system
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Identity of the terminology system
- Definition
- The identification of the code system that defines the meaning of the symbol in the
code.
- Base
- Coding.system [0..1]
- Comment
- 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.
- Type
- uri
- Fixed URI
- https://mos.esante.gouv.fr/NOS/TRE_R216-HL7RoleCode/FHIR/TRE-R216-HL7RoleCode
Mapping
- rim:n/a
- v2:C*E.3
- rim:./codeSystem
- orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RelatedPerson.coding.version Constrained
- Path
- Patient.contact.relationship.coding.version
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Version of the system - if relevant
- Definition
- 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.
- Base
- Coding.version [0..1]
- Comment
- 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.
- Type
- string
Mapping
- rim:n/a
- v2:C*E.7
- rim:./codeSystemVersion
- orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RelatedPerson.coding.code Constrained
- Path
- Patient.contact.relationship.coding.code
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Symbol in syntax defined by the system
- Definition
- 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).
- Base
- Coding.code [0..1]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- code
Mapping
- rim:n/a
- v2:C*E.1
- rim:./code
- orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RelatedPerson.coding.display Constrained
- Path
- Patient.contact.relationship.coding.display
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Representation defined by the system
- Definition
- A representation of the meaning of the code in the system, following the rules of
the system.
- Base
- Coding.display [0..1]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- string
Mapping
- rim:n/a
- v2:C*E.2 - but note this is not well followed
- rim:CV.displayName
- orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RelatedPerson.coding.userSelected Constrained
- Path
- Patient.contact.relationship.coding.userSelected
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- If this coding was chosen directly by the user
- Definition
- Indicates that this coding was chosen by a user directly - e.g. off a pick list of
available items (codes or displays).
- Base
- Coding.userSelected [0..1]
- Comment
- 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.
- Type
- boolean
Mapping
- rim:n/a
- v2:Sometimes implied by being first
- rim:CD.codingRationale
- orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected
fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map;
fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source
"true"; fhir:target dt:CDCoding.codingRationale\#O ]
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.relationship:RelatedPerson.text Constrained
- Path
- Patient.contact.relationship.text
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Plain text representation of the concept
- Definition
- 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.
- Base
- CodeableConcept.text [0..1]
- Comment
- Very often the text is the same as a displayName of one of the codings.
- Type
- string
Mapping
- rim:n/a
- v2:C*E.9. But note many systems use C*E.2 for this
- rim:./originalText[mediaType/code="text/plain"]/data
- orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.name Constrained
- Path
- Patient.contact.name
- Cardinality
- 0..1
- Short Description
- Name of a human - parts and usage
- Definition
- A human's name with the ability to identify parts and usage.
- Base
- Patient.contact.name [0..1]
- Comment
- Names may be changed, or repudiated, or people may have different names in different
contexts. Names may be divided into parts of different type that have variable significance
depending on context, though the division into parts does not always matter. With
personal names, the different parts might or might not be imbued with some implicit
meaning; various cultures associate different importance with the name parts and the
degree to which systems must care about name parts around the world varies widely.
- Type
- HumanName
Mapping
- rim:n/a
- v2:XPN
- rim:EN (actually, PN)
- servd:ProviderName
- v2:NK1-2
- rim:name
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.telecom Constrained
- Path
- Patient.contact.telecom
- Cardinality
- 0..*
- Short Description
- Details of a Technology mediated contact point (phone, fax, email, etc.)
- Definition
- Details for all kinds of technology mediated contact points for a person or organization,
including telephone, email, etc.
- Base
- Patient.contact.telecom [0..*]
- Comment
- Contact may have multiple ways to be contacted with different uses or applicable periods.
May need to have options for contacting the person urgently, and also to help with
identification.
- Type
- ContactPoint
Mapping
- rim:n/a
- v2:XTN
- rim:TEL
- servd:ContactPoint
- v2:NK1-5, NK1-6, NK1-40
- rim:telecom
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorcpt-2
- Description
- A system is required if a value is provided.
- Expression
value.empty() or system.exists()- XPath
- not(exists(f:value)) or exists(f:system)
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.contact.address Constrained
- Path
- Patient.contact.address
- Cardinality
- 0..1
- Short Description
- Address for the contact person
- Definition
- Address for the contact person.
- Base
- Patient.contact.address [0..1]
- Comment
- Note: address is intended to describe postal addresses for administrative purposes,
not to describe absolute geographical coordinates. Postal addresses are often used
as proxies for physical locations (also see the [Location](location.html#) resource).
- Type
- Address
Mapping
- rim:n/a
- v2:XAD
- rim:AD
- servd:Address
- v2:NK1-4
- rim:addr
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.gender Binding Constrained
- Path
- Patient.contact.gender
- Cardinality
- 0..1
- Short Description
- male | female | other | unknown
- Definition
- Administrative Gender - the gender that the contact person is considered to have for
administration and record keeping purposes.
- Base
- Patient.contact.gender [0..1]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- code
- Binding
- AdministrativeGender(required) : The gender of a person used for administrative purposes.
Mapping
- rim:n/a
- v2:NK1-15
- rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.contact.organization Constrained
- Path
- Patient.contact.organization
- Cardinality
- 0..1
- Short Description
- Organization that is associated with the contact
- Definition
- Organization on behalf of which the contact is acting or for which the contact is
working.
- Base
- Patient.contact.organization [0..1]
- Comment
- References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable
(allowing for access control, temporary unavailability, etc.). Resolution can be either
by retrieval from the URL, or, where applicable by resource type, by treating an absolute
reference as a canonical URL and looking it up in a local registry/repository.
- Type
- Reference > http://hl7.org/fhir/StructureDefinition/Organization
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
- rim:scoper
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.contact.period Constrained
- Path
- Patient.contact.period
- Cardinality
- 0..1
- Short Description
- The period during which this contact person or organization is valid to be contacted
relating to this patient
- Definition
- The period during which this contact person or organization is valid to be contacted
relating to this patient.
- Base
- Patient.contact.period [0..1]
- Comment
- A Period specifies a range of time; the context of use will specify whether the entire
range applies (e.g. "the patient was an inpatient of the hospital for this time range")
or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).
- Type
- Period
Mapping
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- rim:effectiveTime
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorper-1
- Description
- If present, start SHALL have a lower value than end
- Expression
start.hasValue().not() or end.hasValue().not() or (start <= end)- XPath
- not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value)
<= xs:dateTime(f:end/@value))
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.communication Constrained
- Path
- Patient.communication
- Cardinality
- 0..*
- Short Description
- A language which may be used to communicate with the patient about his or her health
- Definition
- A language which may be used to communicate with the patient about his or her health.
- Base
- Patient.communication [0..*]
- Comment
- If no language is specified, this *implies* that the default local language is spoken.
If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication
associations. For animals, language is not a relevant field, and should be absent
from the instance. If the Patient does not speak the default local language, then
the Interpreter Required Standard can be used to explicitly declare that an interpreter
is required.
- Type
- BackboneElement
Mapping
- rim:n/a
- rim:LanguageCommunication
- cda:patient.languageCommunication
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.communication.id
- Path
- Patient.communication.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.communication.extension Constrained
- Path
- Patient.communication.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.communication.modifierExtension Constrained
- Path
- Patient.communication.modifierExtension
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Extensions that cannot be ignored even if unrecognized
- Definition
- May be used to represent additional information that is not part of the basic definition
of the element and that modifies the understanding of the element in which it is contained
and/or the understanding of the containing element's descendants. Usually modifier
elements provide negation or qualification. 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. Applications processing
a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource
(including cannot change the meaning of modifierExtension itself).
- Base
- BackboneElement.modifierExtension [0..*]
- Comment
- 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.
- Alias
- extensions, user content, modifiers
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.communication.language Binding Constrained
- Path
- Patient.communication.language
- Cardinality
- 1..1
- Short Description
- The language which can be used to communicate with the patient about his or her health
- Definition
- The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by
a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for
English, or "en-US" for American English versus "en-EN" for England English.
- Base
- Patient.communication.language [1..1]
- Comment
- The structure aa-BB with this exact casing is one the most widely used notations for
locale. However not all systems actually code this but instead have it as free text.
Hence CodeableConcept instead of code as the data type.
- Type
- CodeableConcept
- Binding
- Language(preferred) : A human language.
Mapping
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:PID-15, LAN-2
- rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
- cda:.languageCode
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.communication.preferred Constrained
- Path
- Patient.communication.preferred
- Cardinality
- 0..1
- Short Description
- Language preference indicator
- Definition
- Indicates whether or not the patient prefers this language (over other languages he
masters up a certain level).
- Base
- Patient.communication.preferred [0..1]
- Comment
- This language is specifically identified for communicating healthcare information.
- Type
- boolean
Mapping
- rim:n/a
- v2:PID-15
- rim:preferenceInd
- cda:.preferenceInd
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.generalPractitioner Constrained
- Path
- Patient.generalPractitioner
- Cardinality
- 0..*
- Short Description
- Patient's nominated primary care provider
- Definition
- Patient's nominated care provider.
- Base
- Patient.generalPractitioner [0..*]
- Comment
- This may be the primary care provider (in a GP context), or it may be a patient nominated
care manager in a community/disability setting, or even organization that will provide
people to perform the care provider roles. It is not to be used to record Care Teams,
these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare
resources.
Multiple GPs may be recorded against the patient for various reasons, such as a student
that has his home GP listed along with the GP at university during the school semesters,
or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP
to remain aware of medical issues.
Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per
type.
- Alias
- careProvider
- Type
- Reference > http://interopsante.org/fhir/StructureDefinition/FrPractitioner
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:PD1-4
- rim:subjectOf.CareEvent.performer.AssignedEntity
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.managingOrganization Constrained
- Path
- Patient.managingOrganization
- Cardinality
- 0..1
- Part of a summary ?
- true
- Short Description
- Organization that is the custodian of the patient record
- Definition
- Organization that is the custodian of the patient record.
- Base
- Patient.managingOrganization [0..1]
- Comment
- There is only one managing organization for a specific patient record. Other organizations
will have their own Patient record, and may use the Link property to join the records
together (or a Person resource which can include confidence ratings for the association).
- Type
- Reference > http://interopsante.org/fhir/StructureDefinition/FrOrganization
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim:scoper
- cda:.providerOrganization
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.link Constrained
- Path
- Patient.link
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Link to another patient resource that concerns the same actual person
- Definition
- Link to another patient resource that concerns the same actual patient.
- Base
- Patient.link [0..*]
- Comment
- There is no assumption that linked patient records have mutual links.
- Type
- BackboneElement
Mapping
- rim:n/a
- rim:outboundLink
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
Patient.link.id
- Path
- Patient.link.id
- Cardinality
- 0..1
- Representation
- Short Description
- Unique id for inter-element referencing
- Definition
- Unique id for the element within a resource (for internal references). This may be
any string value that does not contain spaces.
- Base
- Element.id [0..1]
- Type
- http://hl7.org/fhirpath/System.String
Mapping
Patient.link.extension Constrained
- Path
- Patient.link.extension
- Cardinality
- 0..*
- Slicing
-
- Descriminator type:value
- Descriminator path:url
- Rules:open
- Short Description
- Additional content defined by implementations
- Definition
- 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.
- Base
- Element.extension [0..*]
- Comment
- 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.
- Alias
- extensions, user content
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.link.modifierExtension Constrained
- Path
- Patient.link.modifierExtension
- Cardinality
- 0..*
- Part of a summary ?
- true
- Short Description
- Extensions that cannot be ignored even if unrecognized
- Definition
- May be used to represent additional information that is not part of the basic definition
of the element and that modifies the understanding of the element in which it is contained
and/or the understanding of the containing element's descendants. Usually modifier
elements provide negation or qualification. 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. Applications processing
a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource
(including cannot change the meaning of modifierExtension itself).
- Base
- BackboneElement.modifierExtension [0..*]
- Comment
- 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.
- Alias
- extensions, user content, modifiers
- Type
- Extension
Mapping
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorext-1
- Description
- Must have either extensions or value[x], not both
- Expression
extension.exists() != value.exists()- XPath
- exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
- Source
- http://hl7.org/fhir/StructureDefinition/DomainResource
Patient.link.other Constrained
- Path
- Patient.link.other
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- The other patient or related person resource that the link refers to
- Definition
- The other patient resource that the link refers to.
- Base
- Patient.link.other [1..1]
- Comment
- Referencing a RelatedPerson here removes the need to use a Person record to associate
a Patient and RelatedPerson as the same individual.
- Type
- Reference > http://hl7.org/fhir/StructureDefinition/Patient
Mapping
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:PID-3, MRG-1
- rim:id
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element
- Severity
- errorref-1
- Description
- SHALL have a contained resource if a local reference is provided
- Expression
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))- XPath
- not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value,
'#')])
- Source
- http://hl7.org/fhir/StructureDefinition/Patient
Patient.link.type Binding Constrained
- Path
- Patient.link.type
- Cardinality
- 1..1
- Part of a summary ?
- true
- Short Description
- replaced-by | replaces | refer | seealso
- Definition
- The type of link between this patient resource and another patient resource.
- Base
- Patient.link.type [1..1]
- Comment
- Note that FHIR strings SHALL NOT exceed 1MB in size
- Type
- code
- Binding
- LinkType(required) : The type of link between this patient resource and another patient resource.
Mapping
- rim:n/a
- rim:typeCode
- cda:n/a
Constraints
- Severity
- errorele-1
- Description
- All FHIR elements must have a @value or children
- Expression
hasValue() or (children().count() > id.count())- XPath
- @value|f:*|h:div
- Source
- http://hl7.org/fhir/StructureDefinition/Element