Canonical url | https://fake-acme.org/fhir/StructureDefinition/ACME-base-patient |
Version | 1.0.0 |
Published by | Example, blamethem@fake-acme.org |
Status | active (since 2019-09-13) |
This Structure Definition defines the required elements and constraints on the Patient
resource that is derived from US Core Patient Profile .
This is our snapshot.
ACME Base Patient (Patient) | I | US Core Patient Profile | There are no (further) constraints on this element Element idPatient US Core Patient Profile Alternate namesSubjectOfCare Client Resident DefinitionThe US Core Patient Profile is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements from the 2015 Edition Common Clinical Data Set.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idPatient.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. 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 in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | Element idPatient.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
race | S I | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:race US Core Race Extension Alternate namesextensions, user content DefinitionConcepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories: - American Indian or Alaska Native - Asian - Black or African American - Native Hawaiian or Other Pacific Islander - White. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:race.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | Element idPatient.extension:race.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
ombCategory | S I | 0..5 | Extension | There are no (further) constraints on this element Element idPatient.extension:race.extension:ombCategory American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White Alternate namesextensions, user content DefinitionThe 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:race.extension:ombCategory.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:race.extension:ombCategory.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:race.extension:ombCategory.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
ombCategory
| |
valueCoding | 1..1 | CodingBinding | There are no (further) constraints on this element Element idPatient.extension:race.extension:ombCategory.valueCoding:valueCoding Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). The 5 race category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.whitehouse.gov/omb/fedreg_1997standards). OMB Race Categories (required)Constraints
| |
detailed | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:race.extension:detailed Extended race codes Alternate namesextensions, user content DefinitionThe 900+ CDC race codes that are grouped under one of the 5 OMB race category codes:. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:race.extension:detailed.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:race.extension:detailed.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:race.extension:detailed.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
detailed
| |
valueCoding | 1..1 | CodingBinding | There are no (further) constraints on this element Element idPatient.extension:race.extension:detailed.valueCoding:valueCoding Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). The [900+ CDC Race codes](http://www.cdc.gov/phin/resources/vocabulary/index.html) that are grouped under one of the 5 OMB race category codes. US-Core Detailed Race (required)Constraints
| |
text | S I | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:race.extension:text Race Text Alternate namesextensions, user content DefinitionPlain text representation of the race concept(s). 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:race.extension:text.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:race.extension:text.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:race.extension:text.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
text
| |
valueString | 1..1 | string | There are no (further) constraints on this element Element idPatient.extension:race.extension:text.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| |
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:race.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idPatient.extension:race.value[x] Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCode | code | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueId | id | There are no (further) constraints on this element Data type | ||
valueInstant | instant | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data type | ||
valueOid | oid | There are no (further) constraints on this element Data type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueAddress | Address | There are no (further) constraints on this element Data type | ||
valueAge | Age | There are no (further) constraints on this element Data type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data type | ||
valueCount | Count | There are no (further) constraints on this element Data type | ||
valueDistance | Distance | There are no (further) constraints on this element Data type | ||
valueDuration | Duration | There are no (further) constraints on this element Data type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
valuePeriod | Period | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||
valueSignature | Signature | There are no (further) constraints on this element Data type | ||
valueTiming | Timing | There are no (further) constraints on this element Data type | ||
valueMeta | Meta | There are no (further) constraints on this element Data type | ||
valueReference | Reference() | There are no (further) constraints on this element Data type | ||
ethnicity | S I | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:ethnicity US Core ethnicity Extension Alternate namesextensions, user content DefinitionConcepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:ethnicity.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | Element idPatient.extension:ethnicity.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
ombCategory | S I | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:ombCategory Hispanic or Latino|Not Hispanic or Latino Alternate namesextensions, user content DefinitionThe 2 ethnicity category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:ombCategory.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:ombCategory.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:ombCategory.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
ombCategory
| |
valueCoding | 1..1 | CodingBinding | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:ombCategory.valueCoding:valueCoding Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). The 2 ethnicity category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.whitehouse.gov/omb/fedreg_1997standards). OMB Ethnicity Categories (required)Constraints
| |
detailed | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:detailed Extended ethnicity codes Alternate namesextensions, user content DefinitionThe 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:detailed.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:detailed.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:detailed.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
detailed
| |
valueCoding | 1..1 | CodingBinding | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:detailed.valueCoding:valueCoding Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). The 41 [CDC ethnicity codes](http://www.cdc.gov/phin/resources/vocabulary/index.html) that are grouped under one of the 2 OMB ethnicity category codes. US-Core Detailed ethnicity (required)Constraints
| |
text | S I | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:text ethnicity Text Alternate namesextensions, user content DefinitionPlain text representation of the ethnicity concept(s). 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:text.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:text.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:text.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
text
| |
valueString | 1..1 | string | There are no (further) constraints on this element Element idPatient.extension:ethnicity.extension:text.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| |
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:ethnicity.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idPatient.extension:ethnicity.value[x] Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCode | code | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueId | id | There are no (further) constraints on this element Data type | ||
valueInstant | instant | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data type | ||
valueOid | oid | There are no (further) constraints on this element Data type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueAddress | Address | There are no (further) constraints on this element Data type | ||
valueAge | Age | There are no (further) constraints on this element Data type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data type | ||
valueCount | Count | There are no (further) constraints on this element Data type | ||
valueDistance | Distance | There are no (further) constraints on this element Data type | ||
valueDuration | Duration | There are no (further) constraints on this element Data type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
valuePeriod | Period | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||
valueSignature | Signature | There are no (further) constraints on this element Data type | ||
valueTiming | Timing | There are no (further) constraints on this element Data type | ||
valueMeta | Meta | There are no (further) constraints on this element Data type | ||
valueReference | Reference() | There are no (further) constraints on this element Data type | ||
birthsex | S I | 0..1 | Extension(code)Binding | There are no (further) constraints on this element Element idPatient.extension:birthsex Optional Extensions Element Alternate namesextensions, user content DefinitionA code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC). The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex. http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex BindingCode for sex assigned at birth US Core Birth Sex Value Set (required)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:birthsex.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:birthsex.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:birthsex.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
| |
valueCode | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.extension:birthsex.valueCode:valueCode Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Code for sex assigned at birth US Core Birth Sex Value Set (required)Constraints
| |
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | S Σ | 1..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier.value The value that is unique within the system. DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.active Whether this patient's record is in active use DefinitionWhether this patient record is in active use. Need to be able to mark a patient record as not to be used because it was created in error. Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.
true
|
name | S Σ | 1..* | HumanName | There are no (further) constraints on this element Element idPatient.name A name associated with the patient DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name NameUse (required)Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.text Text representation of the full name DefinitionA full text representation of the name. A renderable, unencoded form. Can provide both a text representation and structured parts.
|
family | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | S Σ | 1..* | string | There are no (further) constraints on this element Element idPatient.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.
|
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings may not exceed 1MB in size
|
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings may not exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
|
telecom | Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. 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 may 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).
|
gender | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes. The gender may 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 M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, 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, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error. The gender of a person used for administrative purposes. AdministrativeGender (required)Constraints
|
birthDate | S Σ | 1..1 | date | There are no (further) constraints on this element Element idPatient.birthDate The date of birth for the individual DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. 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 maternaty/infant care systems).
|
deceased[x] | Σ ?! | 0..1 | There are no (further) constraints on this element Element idPatient.deceased[x] Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. 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. This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
| |
deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
deceasedDateTime | dateTime | There are no (further) constraints on this element Data type | ||
address | Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient.address Addresses for the individual DefinitionAddresses for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Patient may have multiple addresses with different uses or applicable periods.
|
maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatus Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. 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. The domestic partnership status of a person. Marital Status Codes (extensible)Constraints
| |
multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3 If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).
| ||
multipleBirthBoolean | boolean | There are no (further) constraints on this element Data type | ||
multipleBirthInteger | integer | There are no (further) constraints on this element Data type | ||
photo | I | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photo Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment".
|
contact | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contact A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
relationship | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationship The kind of relationship DefinitionThe nature of the relationship between the patient and the contact person. Used to determine which contact person is the most relevant to approach, depending on circumstances. 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. The nature of the relationship between a patient and a contact person for that patient. v2 Contact Role (extensible)Constraints
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.name A name associated with the contact person DefinitionA name associated with the contact person. Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. 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 may or may 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.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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.
|
address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.address Address for the contact person DefinitionAddress for the contact person. Need to keep track where the contact person can be contacted per postal mail or visited. Note: address is for postal addresses, not physical locations.
| |
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings may not exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required)Constraints
| |
organization | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organization Organization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working. For guardians or business related contacts, the organization is relevant. 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.
|
period | I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.period The period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
|
animal | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.animal This patient is known to be an animal (non-human) DefinitionThis patient is known to be an animal. Many clinical systems are extended to care for animal patients as well as human. The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).
|
communication | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.communication A list of Languages which may be used to communicate with the patient about his or her health DefinitionLanguages which may be used to communicate with the patient about his or her health. If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
language | S | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe 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. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. 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. A human language. Language codes with language and optionally a region modifier (extensible)Constraints
|
preferred | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. This language is specifically identified for communicating healthcare information.
| |
generalPractitioner | I | 0..* | Reference(Organization | Practitioner) | There are no (further) constraints on this element Element idPatient.generalPractitioner Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity 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. Reference(Organization | Practitioner) Constraints
|
managingOrganization | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. 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).
|
link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.link Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple usecases:
There is no assumption that linked patient records have mutual links. This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
other | Σ I | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idPatient.link.other The other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Reference(Patient | RelatedPerson) Constraints
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.type replaced-by | replaces | refer | seealso - type of link DefinitionThe type of link between this patient resource and another patient resource. Note that FHIR strings may not exceed 1MB in size The type of link between this patient resource and another patient resource. LinkType (required)Constraints
|
This is an example for this profile:
{ "meta": { "profile": [ "https://fake-acme.org/fhir/StructureDefinition/ACME-base-patient " ] }, "resourceType": "Patient", "id": "f001", "identifier": [ { "use": "usual", "system": "urn:oid:2.16.840.1.113883.2.4.6.3", "value": "738472983" }, { "use": "usual", "system": "urn:oid:2.16.840.1.113883.2.4.6.3" } ], "active": true, "name": [ { "use": "usual", "family": "van de Heuvel", "given": [ "Pieter" ], "suffix": [ "MSc" ] } ], "telecom": [ { "system": "phone", "value": "0648352638", "use": "mobile" }, { "system": "email", "value": "p.heuvel@gmail.com", "use": "home" } ], "gender": "male", "birthDate": "1944-11-17", "deceasedBoolean": false, "address": [ { "use": "home", "line": [ "Van Egmondkade 23" ], "city": "Amsterdam", "postalCode": "1024 RJ", "country": "NLD" } ], "maritalStatus": { "coding": [ { "system": "http://hl7.org/fhir/v3/MaritalStatus", "code": "M", "display": "Married" } ], "text": "Getrouwd" }, "multipleBirthBoolean": true, "contact": [ { "relationship": [ { "coding": [ { "system": "http://hl7.org/fhir/v2/0131", "code": "C" } ] } ], "name": { "use": "usual", "family": "Abels", "given": [ "Sarah" ] }, "telecom": [ { "system": "phone", "value": "0690383372", "use": "mobile" } ] } ], "communication": [ { "language": { "coding": [ { "system": "urn:ietf:bcp:47", "code": "nl", "display": "Dutch" } ], "text": "Nederlands" }, "preferred": true } ], "managingOrganization": { "reference": "Organization/f001", "display": "Burgers University Medical Centre" } }
Narrative: This is Pieter!
Link: Pieter van de Heuvel
{ "meta": { "profile": [ "https://fake-acme.org/fhir/StructureDefinition/ACME-base-patient " ] }, "text": { --- We have skipped the narrative for better readability of the resource --- "status": "additional" }, "resourceType": "Patient", "id": "f001", "identifier": [ { "use": "usual", "system": "urn:oid:2.16.840.1.113883.2.4.6.3", "value": "738472983" }, { "use": "usual", "system": "urn:oid:2.16.840.1.113883.2.4.6.3" } ], "active": true, "name": [ { "use": "usual", "family": "van de Heuvel", "given": [ "Pieter" ], "suffix": [ "MSc" ] } ], "telecom": [ { "system": "phone", "value": "0648352638", "use": "mobile" }, { "system": "email", "value": "p.heuvel@gmail.com", "use": "home" } ], "gender": "male", "birthDate": "1944-11-17", "deceasedBoolean": false, "address": [ { "use": "home", "line": [ "Van Egmondkade 23" ], "city": "Amsterdam", "postalCode": "1024 RJ", "country": "NLD" } ], "maritalStatus": { "coding": [ { "system": "http://hl7.org/fhir/v3/MaritalStatus", "code": "M", "display": "Married" } ], "text": "Getrouwd" }, "multipleBirthBoolean": true, "contact": [ { "relationship": [ { "coding": [ { "system": "http://hl7.org/fhir/v2/0131", "code": "C" } ] } ], "name": { "use": "usual", "family": "Abels", "given": [ "Sarah" ] }, "telecom": [ { "system": "phone", "value": "0690383372", "use": "mobile" } ] } ], "communication": [ { "language": { "coding": [ { "system": "urn:ietf:bcp:47", "code": "nl", "display": "Dutch" } ], "text": "Nederlands" }, "preferred": true } ], "managingOrganization": { "reference": "Organization/f001", "display": "Burgers University Medical Centre" } }
<Patient xmlns="http://hl7.org/fhir"> <id value="f001" /> <meta> <profile value="https://fake-acme.org/fhir/StructureDefinition/ACME-base-patient" /> </meta> <text> <status value="additional" /> --- We have skipped the narrative for better readability of the resource --- </text> <identifier> <use value="usual" /> <system value="urn:oid:2.16.840.1.113883.2.4.6.3" /> <value value="738472983" /> </identifier> <identifier> <use value="usual" /> <system value="urn:oid:2.16.840.1.113883.2.4.6.3" /> </identifier> <active value="true" /> <name> <use value="usual" /> <family value="van de Heuvel" /> <given value="Pieter" /> <suffix value="MSc" /> </name> <telecom> <system value="phone" /> <value value="0648352638" /> <use value="mobile" /> </telecom> <telecom> <system value="email" /> <value value="p.heuvel@gmail.com" /> <use value="home" /> </telecom> <gender value="male" /> <birthDate value="1944-11-17" /> <deceasedBoolean value="false" /> <address> <use value="home" /> <line value="Van Egmondkade 23" /> <city value="Amsterdam" /> <postalCode value="1024 RJ" /> <country value="NLD" /> </address> <maritalStatus> <coding> <system value="http://hl7.org/fhir/v3/MaritalStatus" /> <code value="M" /> <display value="Married" /> </coding> <text value="Getrouwd" /> </maritalStatus> <multipleBirthBoolean value="true" /> <contact> <relationship> <coding> <system value="http://hl7.org/fhir/v2/0131" /> <code value="C" /> </coding> </relationship> <name> <use value="usual" /> <family value="Abels" /> <given value="Sarah" /> </name> <telecom> <system value="phone" /> <value value="0690383372" /> <use value="mobile" /> </telecom> </contact> <communication> <language> <coding> <system value="urn:ietf:bcp:47" /> <code value="nl" /> <display value="Dutch" /> </coding> <text value="Nederlands" /> </language> <preferred value="true" /> </communication> <managingOrganization> <reference value="Organization/f001" /> <display value="Burgers University Medical Centre" /> </managingOrganization> </Patient>
Powered by SIMPLIFIER.NET