CareConnect-CDS-Patient-1
This is the StructureDefinition overview for the CareConnect-CDS-Patient-1
The official URL for this profile is: https
Differential
CareConnect-CDS-Patient-1 (Patient) | C | CareConnect-Patient-1 | There are no (further) constraints on this element Element idPatientShort description Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
| |||
id | S Σ | 1..1 | id | There are no (further) constraints on this element Element idPatient.idShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.metaShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idPatient.meta.versionIdShort description Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idPatient.meta.lastUpdatedShort description When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
profile | Σ | 0..* | uri | There are no (further) constraints on this element Element idPatient.meta.profileShort description Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idPatient.meta.securityShort description Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.security.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.security.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.meta.security.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.security.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.meta.security.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.security.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.meta.security.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.meta.tagShort description Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.tag.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.tag.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.meta.tag.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.tag.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.meta.tag.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.tag.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.meta.tag.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRulesShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.languageShort description 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. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.text.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.text.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.text.statusShort description generated | extensions | additional | empty DefinitionThe status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. Note that FHIR strings may not exceed 1MB in size The status of a resource narrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
div | C | 1..1 | xhtml | There are no (further) constraints on this element Element idPatient.text.divShort description Limited xhtml content DefinitionThe actual narrative content, a stripped down version of XHTML. The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.containedShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
ethnicCategory | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:ethnicCategoryShort description Ethnic category Alternate namesextensions, user content DefinitionThe ethnicity of the subject. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
religiousAffiliation | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:religiousAffiliationShort description Religious affiliation Alternate namesextensions, user content DefinitionThe religious affiliation of the subject. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
patient-cadavericDonor | C | 0..1 | Extension(boolean) | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonorShort description Flag indicating whether the patient authorized the donation of body parts after death Alternate namesextensions, user content DefinitionFlag indicating whether the patient authorized the donation of body parts after death. 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. http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.urlShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://hl7.org/fhir/StructureDefinition/patient-cadavericDonorMappings
| |||
valueBoolean | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.valueBoolean:valueBooleanShort description Flag indicating whether the patient authorized the donation of body parts after death. DefinitionFlag indicating whether the patient authorized the donation of body parts after death. A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
residentialStatus | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:residentialStatusShort description The residential status of the patient Alternate namesextensions, user content DefinitionThe residential status of the patient. For example if this patient is a UK resident. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
treatmentCategory | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:treatmentCategoryShort description The treatment category for this patient Alternate namesextensions, user content DefinitionThe treatment category for this patient. For example if this patient is entitled to free healthcare treatment. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nhsCommunication | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:nhsCommunicationShort description NHS communication preferences for a resource Alternate namesextensions, user content DefinitionCommunication preferences including a list of Languages which may be used for communication 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 URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
birthPlace | C | 0..1 | Extension(Address) | There are no (further) constraints on this element Element idPatient.extension:birthPlaceShort description Birth Place: The registered place of birth of the patient. Alternate namesextensions, user content DefinitionBirth Place: 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. 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. http://hl7.org/fhir/StructureDefinition/birthPlace ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nominatedPharmacy | C | 0..1 | Extension(Reference(CareConnect-Organization-1)) | There are no (further) constraints on this element Element idPatient.extension:nominatedPharmacyShort description A patient's nominated pharmacy Alternate namesextensions, user content DefinitionA patient's nominated pharmacy. 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(Reference(CareConnect-Organization-1)) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
deathNotificationStatus | C | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:deathNotificationStatusShort description Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) Alternate namesextensions, user content DefinitionThis extension is constrained to represent a patient’s death notification (as held on Personal Demographics Service (PDS)). 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 URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
identifier | Σ | 1..* | Identifier | There are no (further) constraints on this element Element idPatient.identifierShort description An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. Unordered, Open At End, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
(All Slices) | The requirements in this element apply to all slices | |||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier.useShort description 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 . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier.typeShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.type.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.identifier.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.type.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.type.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.identifier.type.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.identifier.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.systemShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uriMappings
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.valueShort description The value that is unique 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier.assignerShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.assigner.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.assigner.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.assigner.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier.assigner.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.assigner.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nhsNumber | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier:nhsNumberShort description The patient's NHS number DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nhsNumberVerificationStatus | C | 1..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatusShort description NHS number verification status Alternate namesextensions, user content DefinitionThe verification/tracing status of the NHS number. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.urlShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1Mappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConceptShort description Verification status of the NHS number DefinitionVerification status of the NHS number. A stream of bytes, base64 encoded NHS Number Verification Status Care Connect NHS Number Verification Status (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.idShort description 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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.extensionShort description 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 Mappings
| |||
coding | Σ | 1..1 | CodingBinding | Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.valueCodeableConcept:valueCodeableConcept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Care Connect NHS Number Verification Status (required) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.idShort description 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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.extensionShort description 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 Mappings
| |||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.valueCodeableConcept:valueCodeableConcept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously.
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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.
| ||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.valueCodeableConcept:valueCodeableConcept.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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.
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.identifier:nhsNumber.useShort description 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 . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.typeShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.systemShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uriMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.valueShort description The value that is unique 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456General 1234567890Mappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assignerShort description 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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.activeShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
trueMappings
| ||
name | S Σ | 1..* | HumanName | There are no (further) constraints on this element Element idPatient.nameShort description 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. Unordered, Open At End, by use(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
(All Slices) | The requirements in this element apply to all slices | |||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.useShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.familyShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.givenShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
official | Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.name:officialShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:official.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:official.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idPatient.name:official.useShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name:official.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
family | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name:official.familyShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
given | S Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:official.givenShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:official.prefixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:official.suffixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name:official.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:official.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:official.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name:official.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name:official.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
telecom | Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecomShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings may not exceed 1MB in size Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.telecom.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.telecom.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.genderShort description 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. Administrative Gender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element idPatient.birthDateShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.birthDate.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
patient-birthTime | C | 0..1 | Extension(dateTime) | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTimeShort description The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. Alternate namesextensions, user content DefinitionThe time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. 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. http://hl7.org/fhir/StructureDefinition/patient-birthTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.urlShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://hl7.org/fhir/StructureDefinition/patient-birthTimeMappings
| |||
valueDateTime | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.valueDateTime:valueDateTimeShort description The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. DefinitionThe time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
value | 0..1 | There are no (further) constraints on this element Element idPatient.birthDate.valueShort description Primitive value for date DefinitionPrimitive value for date | ||||
deceased[x] | S Σ ?! | 0..1 | There are no (further) constraints on this element Element idPatient.deceased[x]Short description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
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 | S Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient.addressShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.useShort description home | work | temp | old - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.typeShort description postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Note that FHIR strings may not exceed 1MB in size The type of an address (physical / postal) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.textShort description Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere Street, Erewhon 9132General 42 Grove Street, Overtown, West Yorkshire, LS21 1PFMappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.address.lineShort description Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere StreetGeneral 42 Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.districtShort description District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.stateShort description Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 9132General LS21 1PFMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.countryShort description Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a full country name. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General GBRMappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.periodShort description Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatusShort description 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 (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.maritalStatus.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idPatient.maritalStatus.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://hl7.org/fhir/v3/MaritalStatusMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x]Short description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
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 | C | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photoShort description 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". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.photo.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.photo.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
contentType | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.photo.contentTypeShort description Mime type of the content, with charset etc. DefinitionIdentifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Processors of the data need to be able to know how to interpret the data. Note that FHIR strings may not exceed 1MB in size The mime type of an attachment. Any valid mime type is allowed. http://www.rfc-editor.org/bcp/bcp13.txt (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General text/plain; charset=UTF-8, image/pngMappings
| ||
language | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.photo.languageShort description Human language of the content (BCP-47) DefinitionThe human language of the content. The value can be any valid value according to BCP 47. Users need to be able to choose between the languages in a set of attachments. Note that FHIR strings may not exceed 1MB in size A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General en-AUMappings
| ||
data | 0..1 | base64Binary | There are no (further) constraints on this element Element idPatient.photo.dataShort description Data inline, base64ed DefinitionThe actual data of the attachment - a sequence of bytes. In XML, represented using base64. The data needs to able to be transmitted inline. The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
url | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.photo.urlShort description Uri where the data can be found DefinitionAn alternative location where the data can be accessed. The data needs to be transmitted by reference. If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/logo-small.pngMappings
| ||
size | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idPatient.photo.sizeShort description Number of bytes of content (if url provided) DefinitionThe number of bytes of data that make up this attachment (before base64 encoding, if that is done). Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
hash | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element idPatient.photo.hashShort description Hash of the data (sha-1, base64ed) DefinitionThe calculated hash of the data using SHA-1. Represented using base64. Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature. The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.photo.titleShort description Label to display in place of the data DefinitionA label or set of text to display in place of the data. Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General Official Corporate LogoMappings
| ||
creation | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.photo.creationShort description Date attachment was first created DefinitionThe date that the attachment was first created. This is often tracked as an integrity issue for use of the attachment. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
contact | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contactShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtensionShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
relationship | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationshipShort description 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. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.relationship.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.contact.relationship.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
name | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.nameShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.name.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.name.useShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.familyShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.givenShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.prefixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.suffixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.name.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.name.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.name.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.name.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecomShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings may not exceed 1MB in size Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.contact.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.telecom.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.telecom.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.addressShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.address.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.address.useShort description home | work | temp | old - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.address.typeShort description postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Note that FHIR strings may not exceed 1MB in size The type of an address (physical / postal) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.textShort description Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere Street, Erewhon 9132General 120, Grove Street, Overtown, West Yorkshire, LS21 1PTMappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.address.lineShort description Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere StreetGeneral 120, Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.districtShort description District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.stateShort description Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 9132General LS21 1PTMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.countryShort description Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a full country name. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General GBRMappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.address.periodShort description Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.address.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.address.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.address.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.genderShort description 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. Administrative Gender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
organization | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.contact.organizationShort description 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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, pat-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.organization.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.organization.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.organization.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.contact.organization.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.organization.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
animal | Σ ?! | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.animalShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
communication | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.communicationShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
generalPractitioner | C | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1) | There are no (further) constraints on this element Element idPatient.generalPractitionerShort description 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(CareConnect-Organization-1 | CareConnect-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.generalPractitioner.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.generalPractitioner.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.generalPractitioner.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.generalPractitioner.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.generalPractitioner.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
managingOrganization | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.managingOrganizationShort description 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). Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.managingOrganization.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.managingOrganization.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.managingOrganization.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.managingOrganization.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.managingOrganization.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.linkShort description 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'. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtensionShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
other | Σ C | 1..1 | Reference(RelatedPerson | CareConnect-Patient-1) | There are no (further) constraints on this element Element idPatient.link.otherShort description 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(RelatedPerson | CareConnect-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.other.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.other.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.other.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.link.other.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.other.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.typeShort description 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. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Hybrid
CareConnect-CDS-Patient-1 (Patient) | C | CareConnect-Patient-1 | There are no (further) constraints on this element Element idPatientShort description Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
| |||
id | S Σ | 1..1 | id | There are no (further) constraints on this element Element idPatient.idShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.metaShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idPatient.meta.versionIdShort description Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idPatient.meta.lastUpdatedShort description When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
profile | Σ | 0..* | uri | There are no (further) constraints on this element Element idPatient.meta.profileShort description Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idPatient.meta.securityShort description Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.security.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.security.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.meta.security.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.security.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.meta.security.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.security.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.meta.security.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.meta.tagShort description Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.tag.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.tag.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.meta.tag.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.tag.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.meta.tag.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.tag.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.meta.tag.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRulesShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.languageShort description 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. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.text.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.text.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.text.statusShort description generated | extensions | additional | empty DefinitionThe status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. Note that FHIR strings may not exceed 1MB in size The status of a resource narrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
div | C | 1..1 | xhtml | There are no (further) constraints on this element Element idPatient.text.divShort description Limited xhtml content DefinitionThe actual narrative content, a stripped down version of XHTML. The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.containedShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
ethnicCategory | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:ethnicCategoryShort description Ethnic category Alternate namesextensions, user content DefinitionThe ethnicity of the subject. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
religiousAffiliation | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:religiousAffiliationShort description Religious affiliation Alternate namesextensions, user content DefinitionThe religious affiliation of the subject. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
patient-cadavericDonor | C | 0..1 | Extension(boolean) | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonorShort description Flag indicating whether the patient authorized the donation of body parts after death Alternate namesextensions, user content DefinitionFlag indicating whether the patient authorized the donation of body parts after death. 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. http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.urlShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://hl7.org/fhir/StructureDefinition/patient-cadavericDonorMappings
| |||
valueBoolean | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.valueBoolean:valueBooleanShort description Flag indicating whether the patient authorized the donation of body parts after death. DefinitionFlag indicating whether the patient authorized the donation of body parts after death. A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
residentialStatus | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:residentialStatusShort description The residential status of the patient Alternate namesextensions, user content DefinitionThe residential status of the patient. For example if this patient is a UK resident. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
treatmentCategory | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:treatmentCategoryShort description The treatment category for this patient Alternate namesextensions, user content DefinitionThe treatment category for this patient. For example if this patient is entitled to free healthcare treatment. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nhsCommunication | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:nhsCommunicationShort description NHS communication preferences for a resource Alternate namesextensions, user content DefinitionCommunication preferences including a list of Languages which may be used for communication 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 URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
birthPlace | C | 0..1 | Extension(Address) | There are no (further) constraints on this element Element idPatient.extension:birthPlaceShort description Birth Place: The registered place of birth of the patient. Alternate namesextensions, user content DefinitionBirth Place: 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. 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. http://hl7.org/fhir/StructureDefinition/birthPlace ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nominatedPharmacy | C | 0..1 | Extension(Reference(CareConnect-Organization-1)) | There are no (further) constraints on this element Element idPatient.extension:nominatedPharmacyShort description A patient's nominated pharmacy Alternate namesextensions, user content DefinitionA patient's nominated pharmacy. 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(Reference(CareConnect-Organization-1)) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
deathNotificationStatus | C | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:deathNotificationStatusShort description Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) Alternate namesextensions, user content DefinitionThis extension is constrained to represent a patient’s death notification (as held on Personal Demographics Service (PDS)). 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 URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
identifier | Σ | 1..* | Identifier | There are no (further) constraints on this element Element idPatient.identifierShort description An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. Unordered, Open At End, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
(All Slices) | The requirements in this element apply to all slices | |||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier.useShort description 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 . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier.typeShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.type.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.identifier.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.type.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.type.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.identifier.type.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.identifier.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.systemShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uriMappings
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.valueShort description The value that is unique 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier.assignerShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.assigner.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.assigner.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.assigner.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier.assigner.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.assigner.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nhsNumber | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier:nhsNumberShort description The patient's NHS number DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nhsNumberVerificationStatus | C | 1..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatusShort description NHS number verification status Alternate namesextensions, user content DefinitionThe verification/tracing status of the NHS number. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.urlShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1Mappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConceptShort description Verification status of the NHS number DefinitionVerification status of the NHS number. A stream of bytes, base64 encoded NHS Number Verification Status Care Connect NHS Number Verification Status (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.idShort description 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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.extensionShort description 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 Mappings
| |||
coding | Σ | 1..1 | CodingBinding | Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.valueCodeableConcept:valueCodeableConcept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Care Connect NHS Number Verification Status (required) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.idShort description 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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.extensionShort description 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 Mappings
| |||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.valueCodeableConcept:valueCodeableConcept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously.
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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.
| ||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.valueCodeableConcept:valueCodeableConcept.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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.
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.identifier:nhsNumber.useShort description 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 . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.typeShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.systemShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uriMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.valueShort description The value that is unique 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456General 1234567890Mappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assignerShort description 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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.activeShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
trueMappings
| ||
name | S Σ | 1..* | HumanName | There are no (further) constraints on this element Element idPatient.nameShort description 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. Unordered, Open At End, by use(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
(All Slices) | The requirements in this element apply to all slices | |||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.useShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.familyShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.givenShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
official | Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.name:officialShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:official.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:official.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idPatient.name:official.useShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name:official.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
family | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name:official.familyShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
given | S Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:official.givenShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:official.prefixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:official.suffixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name:official.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:official.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:official.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name:official.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name:official.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
telecom | Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecomShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings may not exceed 1MB in size Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.telecom.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.telecom.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.genderShort description 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. Administrative Gender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element idPatient.birthDateShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.birthDate.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
patient-birthTime | C | 0..1 | Extension(dateTime) | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTimeShort description The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. Alternate namesextensions, user content DefinitionThe time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. 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. http://hl7.org/fhir/StructureDefinition/patient-birthTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.urlShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://hl7.org/fhir/StructureDefinition/patient-birthTimeMappings
| |||
valueDateTime | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.valueDateTime:valueDateTimeShort description The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. DefinitionThe time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
value | 0..1 | There are no (further) constraints on this element Element idPatient.birthDate.valueShort description Primitive value for date DefinitionPrimitive value for date | ||||
deceased[x] | S Σ ?! | 0..1 | There are no (further) constraints on this element Element idPatient.deceased[x]Short description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
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 | S Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient.addressShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.useShort description home | work | temp | old - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.typeShort description postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Note that FHIR strings may not exceed 1MB in size The type of an address (physical / postal) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.textShort description Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere Street, Erewhon 9132General 42 Grove Street, Overtown, West Yorkshire, LS21 1PFMappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.address.lineShort description Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere StreetGeneral 42 Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.districtShort description District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.stateShort description Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 9132General LS21 1PFMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.countryShort description Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a full country name. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General GBRMappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.periodShort description Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatusShort description 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 (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.maritalStatus.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idPatient.maritalStatus.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://hl7.org/fhir/v3/MaritalStatusMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x]Short description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
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 | C | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photoShort description 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". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.photo.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.photo.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
contentType | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.photo.contentTypeShort description Mime type of the content, with charset etc. DefinitionIdentifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Processors of the data need to be able to know how to interpret the data. Note that FHIR strings may not exceed 1MB in size The mime type of an attachment. Any valid mime type is allowed. http://www.rfc-editor.org/bcp/bcp13.txt (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General text/plain; charset=UTF-8, image/pngMappings
| ||
language | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.photo.languageShort description Human language of the content (BCP-47) DefinitionThe human language of the content. The value can be any valid value according to BCP 47. Users need to be able to choose between the languages in a set of attachments. Note that FHIR strings may not exceed 1MB in size A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General en-AUMappings
| ||
data | 0..1 | base64Binary | There are no (further) constraints on this element Element idPatient.photo.dataShort description Data inline, base64ed DefinitionThe actual data of the attachment - a sequence of bytes. In XML, represented using base64. The data needs to able to be transmitted inline. The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
url | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.photo.urlShort description Uri where the data can be found DefinitionAn alternative location where the data can be accessed. The data needs to be transmitted by reference. If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/logo-small.pngMappings
| ||
size | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idPatient.photo.sizeShort description Number of bytes of content (if url provided) DefinitionThe number of bytes of data that make up this attachment (before base64 encoding, if that is done). Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
hash | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element idPatient.photo.hashShort description Hash of the data (sha-1, base64ed) DefinitionThe calculated hash of the data using SHA-1. Represented using base64. Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature. The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.photo.titleShort description Label to display in place of the data DefinitionA label or set of text to display in place of the data. Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General Official Corporate LogoMappings
| ||
creation | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.photo.creationShort description Date attachment was first created DefinitionThe date that the attachment was first created. This is often tracked as an integrity issue for use of the attachment. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
contact | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contactShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtensionShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
relationship | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationshipShort description 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. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.relationship.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.contact.relationship.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
name | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.nameShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.name.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.name.useShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.familyShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.givenShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.prefixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.suffixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.name.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.name.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.name.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.name.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecomShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings may not exceed 1MB in size Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.contact.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.telecom.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.telecom.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.addressShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.address.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.address.useShort description home | work | temp | old - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.address.typeShort description postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Note that FHIR strings may not exceed 1MB in size The type of an address (physical / postal) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.textShort description Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere Street, Erewhon 9132General 120, Grove Street, Overtown, West Yorkshire, LS21 1PTMappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.address.lineShort description Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere StreetGeneral 120, Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.districtShort description District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.stateShort description Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 9132General LS21 1PTMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.countryShort description Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a full country name. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General GBRMappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.address.periodShort description Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.address.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.address.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.address.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.genderShort description 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. Administrative Gender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
organization | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.contact.organizationShort description 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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, pat-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.organization.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.organization.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.organization.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.contact.organization.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.organization.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
animal | Σ ?! | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.animalShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
communication | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.communicationShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
generalPractitioner | C | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1) | There are no (further) constraints on this element Element idPatient.generalPractitionerShort description 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(CareConnect-Organization-1 | CareConnect-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.generalPractitioner.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.generalPractitioner.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.generalPractitioner.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.generalPractitioner.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.generalPractitioner.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
managingOrganization | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.managingOrganizationShort description 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). Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.managingOrganization.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.managingOrganization.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.managingOrganization.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.managingOrganization.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.managingOrganization.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.linkShort description 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'. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtensionShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
other | Σ C | 1..1 | Reference(RelatedPerson | CareConnect-Patient-1) | There are no (further) constraints on this element Element idPatient.link.otherShort description 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(RelatedPerson | CareConnect-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.other.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.other.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.other.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.link.other.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.other.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.typeShort description 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. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Snapshot (default)
CareConnect-CDS-Patient-1 (Patient) | C | CareConnect-Patient-1 | There are no (further) constraints on this element Element idPatientShort description Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
| |||
id | S Σ | 1..1 | id | There are no (further) constraints on this element Element idPatient.idShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.metaShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idPatient.meta.versionIdShort description Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idPatient.meta.lastUpdatedShort description When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
profile | Σ | 0..* | uri | There are no (further) constraints on this element Element idPatient.meta.profileShort description Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idPatient.meta.securityShort description Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.security.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.security.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.meta.security.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.security.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.meta.security.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.security.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.meta.security.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.meta.tagShort description Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.tag.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.meta.tag.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.meta.tag.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.tag.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.meta.tag.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.meta.tag.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.meta.tag.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRulesShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.languageShort description 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. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.text.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.text.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.text.statusShort description generated | extensions | additional | empty DefinitionThe status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. Note that FHIR strings may not exceed 1MB in size The status of a resource narrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
div | C | 1..1 | xhtml | There are no (further) constraints on this element Element idPatient.text.divShort description Limited xhtml content DefinitionThe actual narrative content, a stripped down version of XHTML. The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.containedShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
ethnicCategory | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:ethnicCategoryShort description Ethnic category Alternate namesextensions, user content DefinitionThe ethnicity of the subject. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
religiousAffiliation | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:religiousAffiliationShort description Religious affiliation Alternate namesextensions, user content DefinitionThe religious affiliation of the subject. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
patient-cadavericDonor | C | 0..1 | Extension(boolean) | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonorShort description Flag indicating whether the patient authorized the donation of body parts after death Alternate namesextensions, user content DefinitionFlag indicating whether the patient authorized the donation of body parts after death. 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. http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.urlShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://hl7.org/fhir/StructureDefinition/patient-cadavericDonorMappings
| |||
valueBoolean | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.extension:patient-cadavericDonor.valueBoolean:valueBooleanShort description Flag indicating whether the patient authorized the donation of body parts after death. DefinitionFlag indicating whether the patient authorized the donation of body parts after death. A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
residentialStatus | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:residentialStatusShort description The residential status of the patient Alternate namesextensions, user content DefinitionThe residential status of the patient. For example if this patient is a UK resident. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
treatmentCategory | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.extension:treatmentCategoryShort description The treatment category for this patient Alternate namesextensions, user content DefinitionThe treatment category for this patient. For example if this patient is entitled to free healthcare treatment. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nhsCommunication | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:nhsCommunicationShort description NHS communication preferences for a resource Alternate namesextensions, user content DefinitionCommunication preferences including a list of Languages which may be used for communication 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 URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
birthPlace | C | 0..1 | Extension(Address) | There are no (further) constraints on this element Element idPatient.extension:birthPlaceShort description Birth Place: The registered place of birth of the patient. Alternate namesextensions, user content DefinitionBirth Place: 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. 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. http://hl7.org/fhir/StructureDefinition/birthPlace ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nominatedPharmacy | C | 0..1 | Extension(Reference(CareConnect-Organization-1)) | There are no (further) constraints on this element Element idPatient.extension:nominatedPharmacyShort description A patient's nominated pharmacy Alternate namesextensions, user content DefinitionA patient's nominated pharmacy. 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(Reference(CareConnect-Organization-1)) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
deathNotificationStatus | C | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:deathNotificationStatusShort description Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) Alternate namesextensions, user content DefinitionThis extension is constrained to represent a patient’s death notification (as held on Personal Demographics Service (PDS)). 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 URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
identifier | Σ | 1..* | Identifier | There are no (further) constraints on this element Element idPatient.identifierShort description An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. Unordered, Open At End, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
(All Slices) | The requirements in this element apply to all slices | |||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier.useShort description 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 . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier.typeShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.type.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.identifier.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.type.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.type.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.identifier.type.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.identifier.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.type.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.identifier.systemShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uriMappings
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.valueShort description The value that is unique 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier.assignerShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.assigner.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.assigner.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.assigner.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier.assigner.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.assigner.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nhsNumber | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier:nhsNumberShort description The patient's NHS number DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
nhsNumberVerificationStatus | C | 1..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatusShort description NHS number verification status Alternate namesextensions, user content DefinitionThe verification/tracing status of the NHS number. 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.urlShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1Mappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConceptShort description Verification status of the NHS number DefinitionVerification status of the NHS number. A stream of bytes, base64 encoded NHS Number Verification Status Care Connect NHS Number Verification Status (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.idShort description 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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.extensionShort description 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 Mappings
| |||
coding | Σ | 1..1 | CodingBinding | Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.valueCodeableConcept:valueCodeableConcept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Care Connect NHS Number Verification Status (required) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.idShort description 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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.extensionShort description 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 Mappings
| |||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.valueCodeableConcept:valueCodeableConcept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously.
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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.
| ||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.valueCodeableConcept:valueCodeableConcept.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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.
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.identifier:nhsNumber.useShort description 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 . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.typeShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.systemShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uriMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.valueShort description The value that is unique 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456General 1234567890Mappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assignerShort description 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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.activeShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
trueMappings
| ||
name | S Σ | 1..* | HumanName | There are no (further) constraints on this element Element idPatient.nameShort description 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. Unordered, Open At End, by use(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
(All Slices) | The requirements in this element apply to all slices | |||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.useShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.familyShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.givenShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
official | Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.name:officialShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:official.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:official.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idPatient.name:official.useShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name:official.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
family | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name:official.familyShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
given | S Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:official.givenShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:official.prefixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:official.suffixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name:official.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:official.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:official.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name:official.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.name:official.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
telecom | Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecomShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings may not exceed 1MB in size Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.telecom.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.telecom.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.genderShort description 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. Administrative Gender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element idPatient.birthDateShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.birthDate.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
patient-birthTime | C | 0..1 | Extension(dateTime) | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTimeShort description The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. Alternate namesextensions, user content DefinitionThe time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. 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. http://hl7.org/fhir/StructureDefinition/patient-birthTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.urlShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://hl7.org/fhir/StructureDefinition/patient-birthTimeMappings
| |||
valueDateTime | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.birthDate.extension:patient-birthTime.valueDateTime:valueDateTimeShort description The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. DefinitionThe time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
value | 0..1 | There are no (further) constraints on this element Element idPatient.birthDate.valueShort description Primitive value for date DefinitionPrimitive value for date | ||||
deceased[x] | S Σ ?! | 0..1 | There are no (further) constraints on this element Element idPatient.deceased[x]Short description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
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 | S Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient.addressShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.useShort description home | work | temp | old - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.typeShort description postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Note that FHIR strings may not exceed 1MB in size The type of an address (physical / postal) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.textShort description Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere Street, Erewhon 9132General 42 Grove Street, Overtown, West Yorkshire, LS21 1PFMappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.address.lineShort description Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere StreetGeneral 42 Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.districtShort description District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.stateShort description Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 9132General LS21 1PFMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.countryShort description Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a full country name. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General GBRMappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.periodShort description Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatusShort description 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 (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.maritalStatus.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idPatient.maritalStatus.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://hl7.org/fhir/v3/MaritalStatusMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.maritalStatus.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.maritalStatus.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x]Short description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
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 | C | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photoShort description 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". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.photo.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.photo.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
contentType | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.photo.contentTypeShort description Mime type of the content, with charset etc. DefinitionIdentifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Processors of the data need to be able to know how to interpret the data. Note that FHIR strings may not exceed 1MB in size The mime type of an attachment. Any valid mime type is allowed. http://www.rfc-editor.org/bcp/bcp13.txt (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General text/plain; charset=UTF-8, image/pngMappings
| ||
language | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.photo.languageShort description Human language of the content (BCP-47) DefinitionThe human language of the content. The value can be any valid value according to BCP 47. Users need to be able to choose between the languages in a set of attachments. Note that FHIR strings may not exceed 1MB in size A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General en-AUMappings
| ||
data | 0..1 | base64Binary | There are no (further) constraints on this element Element idPatient.photo.dataShort description Data inline, base64ed DefinitionThe actual data of the attachment - a sequence of bytes. In XML, represented using base64. The data needs to able to be transmitted inline. The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
url | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.photo.urlShort description Uri where the data can be found DefinitionAn alternative location where the data can be accessed. The data needs to be transmitted by reference. If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/logo-small.pngMappings
| ||
size | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idPatient.photo.sizeShort description Number of bytes of content (if url provided) DefinitionThe number of bytes of data that make up this attachment (before base64 encoding, if that is done). Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
hash | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element idPatient.photo.hashShort description Hash of the data (sha-1, base64ed) DefinitionThe calculated hash of the data using SHA-1. Represented using base64. Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature. The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.photo.titleShort description Label to display in place of the data DefinitionA label or set of text to display in place of the data. Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General Official Corporate LogoMappings
| ||
creation | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.photo.creationShort description Date attachment was first created DefinitionThe date that the attachment was first created. This is often tracked as an integrity issue for use of the attachment. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
contact | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contactShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtensionShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
relationship | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationshipShort description 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. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.relationship.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.contact.relationship.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.relationship.textShort description Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
name | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.nameShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.name.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.name.useShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.textShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.familyShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.givenShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.prefixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.suffixShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.name.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.name.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.name.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.name.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecomShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
system | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings may not exceed 1MB in size Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.contact.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.telecom.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.telecom.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.addressShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.address.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.address.useShort description home | work | temp | old - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.address.typeShort description postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Note that FHIR strings may not exceed 1MB in size The type of an address (physical / postal) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.textShort description Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere Street, Erewhon 9132General 120, Grove Street, Overtown, West Yorkshire, LS21 1PTMappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.address.lineShort description Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere StreetGeneral 120, Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.districtShort description District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.stateShort description Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 9132General LS21 1PTMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.countryShort description Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a full country name. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General GBRMappings
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.address.periodShort description Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.address.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.address.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.address.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.genderShort description 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. Administrative Gender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
organization | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.contact.organizationShort description 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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, pat-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.organization.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.organization.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.organization.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.contact.organization.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.organization.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.period.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.period.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.contact.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints
| ||
animal | Σ ?! | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.animalShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
communication | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.communicationShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
generalPractitioner | C | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1) | There are no (further) constraints on this element Element idPatient.generalPractitionerShort description 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(CareConnect-Organization-1 | CareConnect-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.generalPractitioner.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.generalPractitioner.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.generalPractitioner.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.generalPractitioner.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.generalPractitioner.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
managingOrganization | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.managingOrganizationShort description 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). Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.managingOrganization.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.managingOrganization.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.managingOrganization.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.managingOrganization.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.managingOrganization.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.linkShort description 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'. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtensionShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
other | Σ C | 1..1 | Reference(RelatedPerson | CareConnect-Patient-1) | There are no (further) constraints on this element Element idPatient.link.otherShort description 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(RelatedPerson | CareConnect-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.other.idShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.other.extensionShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.other.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPatient.link.other.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.other.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.typeShort description 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. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Patient Data Mapping
The table below provides the business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-CDS-Patient-1 profile.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
Patient.id | 1..1 | id | Logical id of Patient from Social Care System and used for referencing resource within the Bundle |
Patient.identifier | 1..* | identifier | Constraint: Multiple identifiers may be provided, however one SHALL be the NHS Number |
Patient.identifier[nhsNumber] | 1..1 | identifier | Constraint: For the NHS Number: Patient.identifier.use = 'official'Patient.identifier.system = 'https |
Patient.identifier[nhsNumber].extension | 1..1 | Extension-CareConnect-NHSNumberVerificationStatus-1 | Constraint: Where Patient.identifier.use='official', the NHS Number Verification Status SHALL be provided |
Patient.name | 1..* | HumanName | Constraint: Multiple names may be provided, however one SHALL be the official name, i.e. Patient.name.use = 'official' |
Patient.name[official].text | 1..1 | string | Constraint: Where Patient.name.use='official', Patient.name.text SHALL be provided |
Patient.name[official].family | 1..1 | string | Constraint: Where Patient.name.use='official', Patient.name.family SHALL be provided |
Patient.name[official].given | 0..* | string | Constraint: Where recorded in the source system, and if Patient.name.use='official', Patient.name.given MUST BE SUPPORTED |
Patient.gender | 0..1 | code | Binding AdministrativeGender |
Patient.birthdate | 0..1 | date | The date of birth for the individual. Where date of birth is not known, the approxiamte age will be shared as a partial date (e.g. YYYY) |
Patient.deceased[x] | 0..1 | boolean | dateTime | Where recorded in the source system, the date of death or deceased flag should be shared. |
Patient.address | 0..* | Address | Where recorded in the source system, the patient's address(es) should be shared, particularly where Patient.address.type='home' |