- CareConnect-SHD-ReferralRequest-1
- CareConnect-SHD-Patient-1
- CareConnect-SHD-Encounter-1
- CareConnect-SHD-Location-1
- CareConnect-SHD-Organization-1
- CareConnect-SHD-Practitioner-1
- SHD-QuestionnaireResponse-PreliminaryNeedsAssessment
- SHD-QuestionnaireResponse-COVID19
- SHD-QuestionnaireResponse-AssessmentNotice
- SHD-QuestionnaireResponse-CHCChecklist
- SHD-QuestionnaireResponse-DischargeNotice
- CareConnect-SHD-Communication-1
Structured Definitions
StructureDefinition | Version |
---|---|
CareConnect-SHD-ReferralRequest-1 | 0.0.1 |
CareConnect-SHD-Patient-1 | 0.0.1 |
CareConnect-SHD-Encounter-1 | 0.0.1 |
CareConnect-SHD-Location-1 | 0.0.1 |
CareConnect-SHD-Organization-1 | 0.0.1 |
CareConnect-SHD-Practitioner-1 | 0.0.1 |
SHD-QuestionnaireResponse-PreliminaryNeedsAssessment | 0.0.1 |
SHD-QuestionnaireResponse-COVID19 | 0.0.1 |
SHD-QuestionnaireResponse-AssessmentNotice | 0.0.1 |
SHD-QuestionnaireResponse-CHCChecklist | 0.0.1 |
SHD-QuestionnaireResponse-DischargeNotice | 0.0.1 |
CareConnect-SHD-Communication-1 | 0.0.1 |
CareConnect-SHD-ReferralRequest-1
This is the StructureDefinition overview for the CareConnect-SHD-ReferralRequest-1
The official URL for this profile is: https
Differential
CareConnect-SHD-ReferralRequest-1 (ReferralRequest) | C | CareConnect-ReferralRequest-1 | There are no (further) constraints on this element Element idReferralRequestShort description A request for referral or transfer of care Alternate namesReferralRequest TransferOfCare Request DefinitionUsed to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idReferralRequest.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. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idReferralRequest.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. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.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. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.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
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idReferralRequest.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: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idReferralRequest.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 | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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) Mappings
| |||
referralRequestMethod | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:referralRequestMethodShort description The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... Alternate namesextensions, user content DefinitionThe method used to send or receive a Referral Request. 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-ReferralRequestMethod-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
sourceOfReferral | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:sourceOfReferralShort description This represents the source of referral Alternate namesextensions, user content DefinitionThe source of referral for a Referral Request. 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-SourceOfReferral-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idReferralRequest.identifierShort description Business identifier DefinitionBusiness identifier that uniquely identifies the referral/care transfer request instance.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.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) Mappings
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idReferralRequest.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.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. Reference(CareConnect-Organization-1) Mappings
| ||
definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idReferralRequest.definitionShort description Instantiates protocol or definition DefinitionA protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. Reference(ActivityDefinition | PlanDefinition) Mappings
| ||
basedOn | Σ | 0..* | Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.basedOnShort description Request fulfilled by this request Alternate namesfulfills DefinitionIndicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part. Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) | ||
replaces | Σ | 0..* | Reference(CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.replacesShort description Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. Reference(CareConnect-ReferralRequest-1) Mappings
| ||
groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idReferralRequest.groupIdentifierShort description Composite request this is part of Alternate namesgrouperId, requisition DefinitionThe business identifier of the logical "grouping" request/order that this referral is a part of. Allows multiple orders to be collected as part of a single requisition. | ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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 idReferralRequest.groupIdentifier.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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) Mappings
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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) Mappings
| ||
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.statusShort description draft | active | suspended | cancelled | completed | entered-in-error | unknown DefinitionThe status of the authorization/intention reflected by the referral request record. Workflow status is handled by the Task resource. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. The status of the referral. Mappings
| ||
intent | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.intentShort description proposal | plan | order Alternate namescategory DefinitionDistinguishes the "level" of authorization/demand implicit in this request. The same resource structure is used when capturing proposals/recommendations, plans and actual requests. Codes identifying the stage lifecycle stage of a request Mappings
| ||
type | S Σ | 1..1 | CodeableConceptBinding | Element idReferralRequest.typeShort description Referral/Transition of care request type DefinitionAn indication of the type of referral (or where applicable the type of transfer of care) request. Codes for types of referral; e.g. consult, transfer, temporary transfer. SHD-ReferralRequestType (required) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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 Mappings
| |||
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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 Mappings
| |||
system | Σ | 1..1 | uriFixed Value | Element idReferralRequest.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. http://snomed.info/sctMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
code | Σ | 1..1 | codeFixed Value | Element idReferralRequest.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. 715591000000108Mappings
| ||
display | Σ | 1..1 | stringFixed Value | Element idReferralRequest.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. Hospital Discharge Notification to Social CareMappings
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
text | Σ | 0..1 | stringFixed Value | Element idReferralRequest.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. Hospital Discharge Notification to Social CareMappings
| ||
priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.priorityShort description Urgency of referral / transfer of care request DefinitionAn indication of the urgency of referral (or where applicable the type of transfer of care) request. Codes indicating the relative priority of the referral. Mappings
| ||
serviceRequested | S Σ | 0..* | CodeableConceptBinding | Element idReferralRequest.serviceRequestedShort description Actions requested as part of the referral DefinitionThe service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. Codes indicating the types of services that might be requested as part of a referral. SHD-ReferralRequestServiceRequested (required) Mappings
| ||
subject | S Σ | 1..1 | Reference(CareConnect-SHD-Patient-1) | Element idReferralRequest.subjectShort description Patient referred to care or transfer DefinitionThe patient who is the subject of a referral or transfer of care request. Referral of family, group or community is to be catered for by profiles. Reference(CareConnect-SHD-Patient-1) Mappings
| ||
context | S Σ | 1..1 | Reference(CareConnect-SHD-Encounter-1) | Element idReferralRequest.contextShort description Originating encounter Alternate namesencounter DefinitionThe encounter at which the request for referral or transfer of care is initiated. Reference(CareConnect-SHD-Encounter-1) Mappings
| ||
occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idReferralRequest.occurrence[x]Short description When the service(s) requested in the referral should occur Alternate namestiming DefinitionThe period of time within which the services identified in the referral/transfer of care is specified or required to occur. Use cases: (1) to indicate that the requested service is not to happen before a specified date, and saving the start date in Period.start; (2) to indicate that the requested service must happen before a specified date, and saving the end date in Period.end; (3) to indicate that the requested service must happen during the specified dates ("start" and "end" values). When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date.
| |||
occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
authoredOn | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.authoredOnShort description Date of creation/activation Alternate namescreatedOn DefinitionDate/DateTime of creation for draft requests and date of activation for active requests.
| ||
requester | S Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idReferralRequest.requesterShort description Who/what is requesting service Alternate namesauthor DefinitionThe individual who initiated the request and has responsibility for its activation.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.requester.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 idReferralRequest.requester.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.requester.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.
| ||
agent | Σ | 1..1 | Reference(CareConnect-SHD-Practitioner-1) | Element idReferralRequest.requester.agentShort description Individual making the request DefinitionThe device, practitioner, etc. who initiated the request. Reference(CareConnect-SHD-Practitioner-1) Mappings
| ||
onBehalfOf | Σ C | 1..1 | Reference(CareConnect-SHD-Organization-1) | Element idReferralRequest.requester.onBehalfOfShort description Organization agent is acting for DefinitionThe organization the device or practitioner was acting on behalf of. Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. Reference(CareConnect-SHD-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: rfr-1 Mappings
| ||
specialty | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.specialtyShort description The clinical specialty (discipline) that the referral is requested for DefinitionIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology. Codes indicating the types of capability the referred to service provider must have. PractitionerSpecialty (example) Mappings
| |||
recipient | Σ | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1) | There are no (further) constraints on this element Element idReferralRequest.recipientShort description Receiver of referral / transfer of care request DefinitionThe healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request. There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations. Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1) Mappings
| ||
reasonCode | S Σ | 1..1 | CodeableConcept | Element idReferralRequest.reasonCodeShort description Reason for referral / transfer of care request DefinitionDetails of why the trust is referring the patient to Social Care for a Supported Discharge Codes indicating why the referral is being requested. SNOMED CT Clinical Findings (example) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.reasonCode.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 idReferralRequest.reasonCode.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idReferralRequest.reasonCode.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.
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.reasonCode.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.
| ||
reasonReference | Σ | 0..* | Reference(CareConnect-Condition-1 | CareConnect-Observation-1) | There are no (further) constraints on this element Element idReferralRequest.reasonReferenceShort description Why is service needed? DefinitionIndicates another resource whose existence justifies this request. Reference(CareConnect-Condition-1 | CareConnect-Observation-1) Mappings
| ||
description | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.descriptionShort description A textual description of the referral DefinitionThe reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary. | |||
supportingInfo | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idReferralRequest.supportingInfoShort description Additonal information to support referral or transfer of care request DefinitionAny additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan. | |||
note | 0..* | Annotation | There are no (further) constraints on this element Element idReferralRequest.noteShort description Comments made about referral request DefinitionComments made about the referral request by any of the participants. | |||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.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 idReferralRequest.note.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
| |||
authorString | S Σ | 0..1 | string | Element idReferralRequest.note.author[x]:authorStringShort description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation.
| ||
time | S Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
text | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.textShort description The annotation - text content DefinitionThe text of the annotation.
| |||
relevantHistory | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idReferralRequest.relevantHistoryShort description Key events in history of request Alternate nameseventHistory DefinitionLinks to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.
|
Hybrid
CareConnect-SHD-ReferralRequest-1 (ReferralRequest) | C | CareConnect-ReferralRequest-1 | There are no (further) constraints on this element Element idReferralRequestShort description A request for referral or transfer of care Alternate namesReferralRequest TransferOfCare Request DefinitionUsed to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idReferralRequest.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. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idReferralRequest.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. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.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. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.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
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idReferralRequest.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: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idReferralRequest.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 | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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) Mappings
| |||
referralRequestMethod | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:referralRequestMethodShort description The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... Alternate namesextensions, user content DefinitionThe method used to send or receive a Referral Request. 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-ReferralRequestMethod-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
sourceOfReferral | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:sourceOfReferralShort description This represents the source of referral Alternate namesextensions, user content DefinitionThe source of referral for a Referral Request. 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-SourceOfReferral-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idReferralRequest.identifierShort description Business identifier DefinitionBusiness identifier that uniquely identifies the referral/care transfer request instance.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.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) Mappings
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idReferralRequest.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.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. Reference(CareConnect-Organization-1) Mappings
| ||
definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idReferralRequest.definitionShort description Instantiates protocol or definition DefinitionA protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. Reference(ActivityDefinition | PlanDefinition) Mappings
| ||
basedOn | Σ | 0..* | Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.basedOnShort description Request fulfilled by this request Alternate namesfulfills DefinitionIndicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part. Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) | ||
replaces | Σ | 0..* | Reference(CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.replacesShort description Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. Reference(CareConnect-ReferralRequest-1) Mappings
| ||
groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idReferralRequest.groupIdentifierShort description Composite request this is part of Alternate namesgrouperId, requisition DefinitionThe business identifier of the logical "grouping" request/order that this referral is a part of. Allows multiple orders to be collected as part of a single requisition. | ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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 idReferralRequest.groupIdentifier.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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) Mappings
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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) Mappings
| ||
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.statusShort description draft | active | suspended | cancelled | completed | entered-in-error | unknown DefinitionThe status of the authorization/intention reflected by the referral request record. Workflow status is handled by the Task resource. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. The status of the referral. Mappings
| ||
intent | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.intentShort description proposal | plan | order Alternate namescategory DefinitionDistinguishes the "level" of authorization/demand implicit in this request. The same resource structure is used when capturing proposals/recommendations, plans and actual requests. Codes identifying the stage lifecycle stage of a request Mappings
| ||
type | S Σ | 1..1 | CodeableConceptBinding | Element idReferralRequest.typeShort description Referral/Transition of care request type DefinitionAn indication of the type of referral (or where applicable the type of transfer of care) request. Codes for types of referral; e.g. consult, transfer, temporary transfer. SHD-ReferralRequestType (required) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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 Mappings
| |||
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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 Mappings
| |||
system | Σ | 1..1 | uriFixed Value | Element idReferralRequest.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. http://snomed.info/sctMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
code | Σ | 1..1 | codeFixed Value | Element idReferralRequest.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. 715591000000108Mappings
| ||
display | Σ | 1..1 | stringFixed Value | Element idReferralRequest.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. Hospital Discharge Notification to Social CareMappings
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
text | Σ | 0..1 | stringFixed Value | Element idReferralRequest.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. Hospital Discharge Notification to Social CareMappings
| ||
priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.priorityShort description Urgency of referral / transfer of care request DefinitionAn indication of the urgency of referral (or where applicable the type of transfer of care) request. Codes indicating the relative priority of the referral. Mappings
| ||
serviceRequested | S Σ | 0..* | CodeableConceptBinding | Element idReferralRequest.serviceRequestedShort description Actions requested as part of the referral DefinitionThe service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. Codes indicating the types of services that might be requested as part of a referral. SHD-ReferralRequestServiceRequested (required) Mappings
| ||
subject | S Σ | 1..1 | Reference(CareConnect-SHD-Patient-1) | Element idReferralRequest.subjectShort description Patient referred to care or transfer DefinitionThe patient who is the subject of a referral or transfer of care request. Referral of family, group or community is to be catered for by profiles. Reference(CareConnect-SHD-Patient-1) Mappings
| ||
context | S Σ | 1..1 | Reference(CareConnect-SHD-Encounter-1) | Element idReferralRequest.contextShort description Originating encounter Alternate namesencounter DefinitionThe encounter at which the request for referral or transfer of care is initiated. Reference(CareConnect-SHD-Encounter-1) Mappings
| ||
occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idReferralRequest.occurrence[x]Short description When the service(s) requested in the referral should occur Alternate namestiming DefinitionThe period of time within which the services identified in the referral/transfer of care is specified or required to occur. Use cases: (1) to indicate that the requested service is not to happen before a specified date, and saving the start date in Period.start; (2) to indicate that the requested service must happen before a specified date, and saving the end date in Period.end; (3) to indicate that the requested service must happen during the specified dates ("start" and "end" values). When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date.
| |||
occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
authoredOn | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.authoredOnShort description Date of creation/activation Alternate namescreatedOn DefinitionDate/DateTime of creation for draft requests and date of activation for active requests.
| ||
requester | S Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idReferralRequest.requesterShort description Who/what is requesting service Alternate namesauthor DefinitionThe individual who initiated the request and has responsibility for its activation.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.requester.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 idReferralRequest.requester.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.requester.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.
| ||
agent | Σ | 1..1 | Reference(CareConnect-SHD-Practitioner-1) | Element idReferralRequest.requester.agentShort description Individual making the request DefinitionThe device, practitioner, etc. who initiated the request. Reference(CareConnect-SHD-Practitioner-1) Mappings
| ||
onBehalfOf | Σ C | 1..1 | Reference(CareConnect-SHD-Organization-1) | Element idReferralRequest.requester.onBehalfOfShort description Organization agent is acting for DefinitionThe organization the device or practitioner was acting on behalf of. Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. Reference(CareConnect-SHD-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: rfr-1 Mappings
| ||
specialty | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.specialtyShort description The clinical specialty (discipline) that the referral is requested for DefinitionIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology. Codes indicating the types of capability the referred to service provider must have. PractitionerSpecialty (example) Mappings
| |||
recipient | Σ | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1) | There are no (further) constraints on this element Element idReferralRequest.recipientShort description Receiver of referral / transfer of care request DefinitionThe healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request. There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations. Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1) Mappings
| ||
reasonCode | S Σ | 1..1 | CodeableConcept | Element idReferralRequest.reasonCodeShort description Reason for referral / transfer of care request DefinitionDetails of why the trust is referring the patient to Social Care for a Supported Discharge Codes indicating why the referral is being requested. SNOMED CT Clinical Findings (example) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.reasonCode.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 idReferralRequest.reasonCode.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idReferralRequest.reasonCode.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.
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.reasonCode.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.
| ||
reasonReference | Σ | 0..* | Reference(CareConnect-Condition-1 | CareConnect-Observation-1) | There are no (further) constraints on this element Element idReferralRequest.reasonReferenceShort description Why is service needed? DefinitionIndicates another resource whose existence justifies this request. Reference(CareConnect-Condition-1 | CareConnect-Observation-1) Mappings
| ||
description | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.descriptionShort description A textual description of the referral DefinitionThe reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary. | |||
supportingInfo | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idReferralRequest.supportingInfoShort description Additonal information to support referral or transfer of care request DefinitionAny additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan. | |||
note | 0..* | Annotation | There are no (further) constraints on this element Element idReferralRequest.noteShort description Comments made about referral request DefinitionComments made about the referral request by any of the participants. | |||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.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 idReferralRequest.note.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
| |||
authorString | S Σ | 0..1 | string | Element idReferralRequest.note.author[x]:authorStringShort description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation.
| ||
time | S Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
text | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.textShort description The annotation - text content DefinitionThe text of the annotation.
| |||
relevantHistory | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idReferralRequest.relevantHistoryShort description Key events in history of request Alternate nameseventHistory DefinitionLinks to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.
|
Snapshot (default)
CareConnect-SHD-ReferralRequest-1 (ReferralRequest) | C | CareConnect-ReferralRequest-1 | There are no (further) constraints on this element Element idReferralRequestShort description A request for referral or transfer of care Alternate namesReferralRequest TransferOfCare Request DefinitionUsed to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idReferralRequest.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. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idReferralRequest.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. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.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. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.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
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idReferralRequest.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: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idReferralRequest.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 | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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) Mappings
| |||
referralRequestMethod | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:referralRequestMethodShort description The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... Alternate namesextensions, user content DefinitionThe method used to send or receive a Referral Request. 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-ReferralRequestMethod-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
sourceOfReferral | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idReferralRequest.extension:sourceOfReferralShort description This represents the source of referral Alternate namesextensions, user content DefinitionThe source of referral for a Referral Request. 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-SourceOfReferral-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idReferralRequest.identifierShort description Business identifier DefinitionBusiness identifier that uniquely identifies the referral/care transfer request instance.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.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) Mappings
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idReferralRequest.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.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. Reference(CareConnect-Organization-1) Mappings
| ||
definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idReferralRequest.definitionShort description Instantiates protocol or definition DefinitionA protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. Reference(ActivityDefinition | PlanDefinition) Mappings
| ||
basedOn | Σ | 0..* | Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.basedOnShort description Request fulfilled by this request Alternate namesfulfills DefinitionIndicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part. Reference(CareConnect-CarePlan-1 | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1) | ||
replaces | Σ | 0..* | Reference(CareConnect-ReferralRequest-1) | There are no (further) constraints on this element Element idReferralRequest.replacesShort description Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. Reference(CareConnect-ReferralRequest-1) Mappings
| ||
groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idReferralRequest.groupIdentifierShort description Composite request this is part of Alternate namesgrouperId, requisition DefinitionThe business identifier of the logical "grouping" request/order that this referral is a part of. Allows multiple orders to be collected as part of a single requisition. | ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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 idReferralRequest.groupIdentifier.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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) Mappings
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idReferralRequest.groupIdentifier.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) Mappings
| ||
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.statusShort description draft | active | suspended | cancelled | completed | entered-in-error | unknown DefinitionThe status of the authorization/intention reflected by the referral request record. Workflow status is handled by the Task resource. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. The status of the referral. Mappings
| ||
intent | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.intentShort description proposal | plan | order Alternate namescategory DefinitionDistinguishes the "level" of authorization/demand implicit in this request. The same resource structure is used when capturing proposals/recommendations, plans and actual requests. Codes identifying the stage lifecycle stage of a request Mappings
| ||
type | S Σ | 1..1 | CodeableConceptBinding | Element idReferralRequest.typeShort description Referral/Transition of care request type DefinitionAn indication of the type of referral (or where applicable the type of transfer of care) request. Codes for types of referral; e.g. consult, transfer, temporary transfer. SHD-ReferralRequestType (required) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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 Mappings
| |||
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.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 Mappings
| |||
system | Σ | 1..1 | uriFixed Value | Element idReferralRequest.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. http://snomed.info/sctMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
code | Σ | 1..1 | codeFixed Value | Element idReferralRequest.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. 715591000000108Mappings
| ||
display | Σ | 1..1 | stringFixed Value | Element idReferralRequest.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. Hospital Discharge Notification to Social CareMappings
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idReferralRequest.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.
| ||
text | Σ | 0..1 | stringFixed Value | Element idReferralRequest.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. Hospital Discharge Notification to Social CareMappings
| ||
priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idReferralRequest.priorityShort description Urgency of referral / transfer of care request DefinitionAn indication of the urgency of referral (or where applicable the type of transfer of care) request. Codes indicating the relative priority of the referral. Mappings
| ||
serviceRequested | S Σ | 0..* | CodeableConceptBinding | Element idReferralRequest.serviceRequestedShort description Actions requested as part of the referral DefinitionThe service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. Codes indicating the types of services that might be requested as part of a referral. SHD-ReferralRequestServiceRequested (required) Mappings
| ||
subject | S Σ | 1..1 | Reference(CareConnect-SHD-Patient-1) | Element idReferralRequest.subjectShort description Patient referred to care or transfer DefinitionThe patient who is the subject of a referral or transfer of care request. Referral of family, group or community is to be catered for by profiles. Reference(CareConnect-SHD-Patient-1) Mappings
| ||
context | S Σ | 1..1 | Reference(CareConnect-SHD-Encounter-1) | Element idReferralRequest.contextShort description Originating encounter Alternate namesencounter DefinitionThe encounter at which the request for referral or transfer of care is initiated. Reference(CareConnect-SHD-Encounter-1) Mappings
| ||
occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idReferralRequest.occurrence[x]Short description When the service(s) requested in the referral should occur Alternate namestiming DefinitionThe period of time within which the services identified in the referral/transfer of care is specified or required to occur. Use cases: (1) to indicate that the requested service is not to happen before a specified date, and saving the start date in Period.start; (2) to indicate that the requested service must happen before a specified date, and saving the end date in Period.end; (3) to indicate that the requested service must happen during the specified dates ("start" and "end" values). When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date.
| |||
occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
authoredOn | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.authoredOnShort description Date of creation/activation Alternate namescreatedOn DefinitionDate/DateTime of creation for draft requests and date of activation for active requests.
| ||
requester | S Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idReferralRequest.requesterShort description Who/what is requesting service Alternate namesauthor DefinitionThe individual who initiated the request and has responsibility for its activation.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.requester.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 idReferralRequest.requester.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idReferralRequest.requester.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.
| ||
agent | Σ | 1..1 | Reference(CareConnect-SHD-Practitioner-1) | Element idReferralRequest.requester.agentShort description Individual making the request DefinitionThe device, practitioner, etc. who initiated the request. Reference(CareConnect-SHD-Practitioner-1) Mappings
| ||
onBehalfOf | Σ C | 1..1 | Reference(CareConnect-SHD-Organization-1) | Element idReferralRequest.requester.onBehalfOfShort description Organization agent is acting for DefinitionThe organization the device or practitioner was acting on behalf of. Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. Reference(CareConnect-SHD-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: rfr-1 Mappings
| ||
specialty | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idReferralRequest.specialtyShort description The clinical specialty (discipline) that the referral is requested for DefinitionIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology. Codes indicating the types of capability the referred to service provider must have. PractitionerSpecialty (example) Mappings
| |||
recipient | Σ | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1) | There are no (further) constraints on this element Element idReferralRequest.recipientShort description Receiver of referral / transfer of care request DefinitionThe healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request. There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations. Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1) Mappings
| ||
reasonCode | S Σ | 1..1 | CodeableConcept | Element idReferralRequest.reasonCodeShort description Reason for referral / transfer of care request DefinitionDetails of why the trust is referring the patient to Social Care for a Supported Discharge Codes indicating why the referral is being requested. SNOMED CT Clinical Findings (example) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.reasonCode.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 idReferralRequest.reasonCode.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idReferralRequest.reasonCode.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.
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.reasonCode.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.
| ||
reasonReference | Σ | 0..* | Reference(CareConnect-Condition-1 | CareConnect-Observation-1) | There are no (further) constraints on this element Element idReferralRequest.reasonReferenceShort description Why is service needed? DefinitionIndicates another resource whose existence justifies this request. Reference(CareConnect-Condition-1 | CareConnect-Observation-1) Mappings
| ||
description | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.descriptionShort description A textual description of the referral DefinitionThe reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary. | |||
supportingInfo | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idReferralRequest.supportingInfoShort description Additonal information to support referral or transfer of care request DefinitionAny additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan. | |||
note | 0..* | Annotation | There are no (further) constraints on this element Element idReferralRequest.noteShort description Comments made about referral request DefinitionComments made about the referral request by any of the participants. | |||
id | 0..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.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 idReferralRequest.note.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
| |||
authorString | S Σ | 0..1 | string | Element idReferralRequest.note.author[x]:authorStringShort description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation.
| ||
time | S Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idReferralRequest.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
text | 1..1 | string | There are no (further) constraints on this element Element idReferralRequest.note.textShort description The annotation - text content DefinitionThe text of the annotation.
| |||
relevantHistory | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idReferralRequest.relevantHistoryShort description Key events in history of request Alternate nameseventHistory DefinitionLinks to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.
|
ReferralRequest Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-SHD-ReferralRequest-1 profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
ReferralRequest.status | 1..1 | code | Binding RequestStatusSee use case guidance for any specific business context constriants. |
ReferralRequest.intent | 1..1 | code | Binding RequestIntentSee use case guidance for any specific business context constriants. |
ReferralRequest.type | 1..1 | CodeableConcept | An indication of the type of referral (i.e. 'Hospital Discharge Notification to Social Care') Binding SHD-ReferralRequestType |
ReferralRequest.type.coding | 1..1 | coding | Codinig for a 'Hospital Discharge Notification to Social Care') |
ReferralRequest.type.coding.system | 1..1 | uri | Fixed Value: "http |
ReferralRequest.type.coding.code | 1..1 | code | Fixed Value: "715591000000108" |
ReferralRequest.type.coding.display | 1..1 | string | Fixed Value: "Hospital Discharge Notification to Social Care" |
ReferralRequest.type.text | 1..1 | string | Fixed Value: "Hospital Discharge Notification to Social Care" |
ReferralRequest.serviceRequested | 0..* | CodeableConcept | Optional element providing an indication of the specific servce being requested as part of the referral (e.g. referral into the Community D2A Hub, or referral to specialist Mental Healh Team' Binding SHD-ReferralRequestServiceRequested |
ReferralRequest.subject | 1..1 | Reference (CareConnect-SHD-Patient-1) | Reference to Patient resource to whom the referral relates. |
ReferralRequest.context | 1..1 | Reference (CareConnect-SHD-Encounter-1) | Reference to Encounter resource for the hospital admission the patient is likely need support in order to ensure a safe discharge. |
ReferralRequest.authoredOn | 1..1 | dateTime | Date referral was sent to the Local Authority |
ReferralRequest.requester.agent | 1..1 | Reference (CareConnect-SHD-Practitioner-1) | Reference to Practitioner resource for the person at the hospital who is responsible for liaising with the local authority in relation to the patient’s discharge. |
ReferralRequest.requester.onBehalfOf | 1..1 | Reference (CareConnect-SHD-Organization-1) | Reference to the Organization resource which the ReferralRequest.requester.agent was acting on behalf of (i.e. the Hospital which is sending the referral) |
ReferralRequest.reasonCode.text | 1..1 | string | Referral MUST include the rationale for why the hospital are referring to Social Care (or other Supported Hospital Discharge pathway). |
ReferralRequest.supportingInfo |
0..1 | Reference (SHD-QuestionnaireResponse-PreliminaryNeedsAssessment) | Optional questionnaire response with additional information that may assist the social care team's assessment of a patient (e.g. accommodation status, strength based assessments, risks, competencies etc.). This QuestionnaireResponse can also be sent/updated separately after the referral. |
ReferralRequest.supportingInfo |
0..1 | Reference (SHD-QuestionnaireResponse-COVID19) | Optional questionnaire response completed by health to share additional information requires during the COVID-19 pandemic (e.g. COVID-19 diagnosis status, self isolation and humanitarian support requirements). This QuestionnaireResponse can also be sent/updated separately after the referral. |
ReferralRequest.supportingInfo |
0..1 | Reference (SHD-QuestionnaireResponse-AssessmentNotice) | Optional questionnaire response to give formal notice of request for Assessment under The Care and Support (Discharge of Hospital Patients) Regulations 2014.Note The Assessment Notice may be sent with the ReferralRequest. However, the API supports an initial referral without, followed by a separate Assessment Notice at a later point in time. |
ReferralRequest.supportingInfo |
0..1 | Reference (SHD-QuestionnaireResponse-CHCChecklist) | Optional questionnaire response to share a copy of a NHS Continuing Healthcare Checklist. The CHCH Checklist can also be sent/updated separately after the referral. |
ReferralRequest.note | 0..* | Annotation | Optional field for any other additional information regarding the referral, e.g. Health Recommendations regarding Social Care Pathway. |
ReferralRequest.note.authorString | 0..1 | string | Optional field for details of who added the note/comment. |
ReferralRequest.note.time | 0..1 | dateTime | Optional field for when the note/comment was added. |
ReferralRequest.note.text | 1..1 | string | Each ReferralRequest.note MUST have a text to represent the actual note/comment. |
CareConnect-SHD-Patient-1
This is the StructureDefinition overview for the CareConnect-SHD-Patient-1
The official URL for this profile is: https
Differential
CareConnect-SHD-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 | Σ | 0..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. | ||
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. | ||
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. | ||
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
| |||
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: dom-1 Mappings
| ||
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 | 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) Mappings
| |||
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 | S C | 0..1 | Extension(Complex) | 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
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.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 | Element idPatient.extension:nhsCommunication.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
| ||
language | S C | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:languageShort description Languages which may be used for communication Alternate namesextensions, user content DefinitionLanguages 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. 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.extension:nhsCommunication.extension:language.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:nhsCommunication.extension:language.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:nhsCommunication.extension:language.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
languageMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:language.value[x]:valueCodeableConceptShort description Languages which may be used for communication DefinitionLanguages which may be used for communication. A stream of bytes, base64 encoded Human Language Care Connect Human Language (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.extension:nhsCommunication.extension:language.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.extension:nhsCommunication.extension:language.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:language.value[x]: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.
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:language.valueCodeableConcept: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.
| ||
preferred | S C | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:preferredShort description Language preference indicator 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. 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.extension:nhsCommunication.extension:preferred.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:nhsCommunication.extension:preferred.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:nhsCommunication.extension:preferred.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
preferredMappings
| |||
valueBoolean | 1..1 | booleanFixed Value | Element idPatient.extension:nhsCommunication.extension:preferred.valueBoolean:valueBooleanShort description Indicates whether or not this language is preferred (over other languages up a certain level) DefinitionIndicates whether or not this language is preferred (over other languages up a certain level) A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
trueMappings
| |||
modeOfCommunication | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:modeOfCommunicationShort description Mode of communication for the selected language 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. 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.extension:nhsCommunication.extension:modeOfCommunication.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:nhsCommunication.extension:modeOfCommunication.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:nhsCommunication.extension:modeOfCommunication.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
modeOfCommunicationMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConceptShort description A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. DefinitionA valueset to describe the mode the patient can communicate in, representing the method of expression of the language.. A stream of bytes, base64 encoded Language Ability Mode Care Connect Language Ability Mode (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
communicationProficiency | C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:communicationProficiencyShort description The level of proficiency in communicating a language 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. 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.extension:nhsCommunication.extension:communicationProficiency.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:nhsCommunication.extension:communicationProficiency.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:nhsCommunication.extension:communicationProficiency.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
communicationProficiencyMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConceptShort description A valueset to describe the level of proficiency in communicating a language DefinitionA valueset to describe the level of proficiency in communicating a language. A stream of bytes, base64 encoded Language Ability Proficiency Care Connect Language Ability Proficiency (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
interpreterRequired | S C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:interpreterRequiredShort description Interpreter preference indicator 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. 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.extension:nhsCommunication.extension:interpreterRequired.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:nhsCommunication.extension:interpreterRequired.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:nhsCommunication.extension:interpreterRequired.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
interpreterRequiredMappings
| |||
valueBoolean | 1..1 | boolean | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:interpreterRequired.valueBoolean:valueBooleanShort description Indicates whether an interpreter is required for communication purposes DefinitionIndicates whether an interpreter is required for communication purposes- True / False? A stream of bytes, base64 encoded The 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:nhsCommunication.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-NHSCommunication-1Mappings
| |||
value[x] | 0..0 | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.value[x]Short description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded The 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 | ?! | 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.
| ||
identifier | Σ | 0..* | 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) Mappings
| ||
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.
| ||
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.
| |||
extension | 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 Mappings
| |||
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
| ||
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 . Fixed valueofficialMappings
| ||
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) Mappings
| ||
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. https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patientMappings
| ||
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. General 123456General 1234567890Mappings
| ||
period | Σ | 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.
| ||
assigner | Σ | 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) Mappings
| ||
localIdentifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier:localIdentifierShort description An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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:localIdentifier.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
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.identifier:localIdentifier.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 . Fixed valuesecondaryMappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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) Mappings
| ||
system | Σ | 1..1 | uriPattern | Element idPatient.identifier:localIdentifier.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. http://www.acme.com/identifiers/patientExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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.
| ||
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. trueMappings
| ||
name | Σ | 0..* | 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) Mappings
| ||
official | S Σ | 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.
| ||
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.
| |||
extension | 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 Mappings
| |||
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 Fixed valueofficialMappings
| ||
text | Σ | 0..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.
| ||
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).
| ||
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.
| ||
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.
| ||
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.
| ||
period | Σ | 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.
| ||
telecom | Σ | 0..* | ContactPoint | 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). Unordered, Open, by system(Value), use(Value) Mappings
| ||
(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.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.
| |||
extension | 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 Mappings
| |||
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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Mappings
| ||
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.
| ||
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 Mappings
| ||
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.
| ||
period | Σ | 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.
| ||
homePhone | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:homePhoneShort 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).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homePhone.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.telecom:homePhone.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homePhone.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed valuephoneMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homePhone.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homePhone.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 Fixed valuehomeMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:homePhone.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:homePhone.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
mobilePhone | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:mobilePhoneShort 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).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.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.telecom:mobilePhone.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:mobilePhone.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed valuephoneMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:mobilePhone.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 Fixed valuemobileMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
homeEmail | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:homeEmailShort 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).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.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.telecom:homeEmail.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homeEmail.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed value
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homeEmail.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 Fixed valuehomeMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
gender | S Σ | 1..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) Mappings
| ||
birthDate | S Σ | 1..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).
| ||
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) | |||
extension | 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 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) | |||
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 DefinitionThe actual value | ||||
deceased[x] | Σ ?! | 0..0 | 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.
| |||
address | Σ | 0..* | Address | 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. Unordered, Open, by use(Value) Mappings
| ||
(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.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.
| |||
extension | 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 Mappings
| |||
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 ExamplesGeneral 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. The type of an address (physical / postal) ExamplesGeneral 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. 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. 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. 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. 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).
| ||
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. 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. General GBRMappings
| ||
period | Σ | 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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
homeAddress | S Σ | 1..1 | Address | There are no (further) constraints on this element Element idPatient.address:homeAddressShort 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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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.address:homeAddress.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
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.address:homeAddress.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 Fixed valuehomeExamples General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General 137 Nowhere Street, Erewhon 9132General 42 Grove Street, Overtown, West Yorkshire, LS21 1PFMappings
| ||
line | Σ | 2..5 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General 137 Nowhere StreetGeneral 42 Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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).
| ||
postalCode | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132General LS21 1PFMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General GBRMappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
maritalStatus | S | 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. The domestic partnership status of a person. Marital Status Codes (required) Mappings
| ||
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.
| |||
extension | 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 Mappings
| |||
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.
| ||
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.
| |||
extension | 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 Mappings
| |||
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. 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.
| ||
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.
| ||
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.
| ||
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.
| ||
text | Σ | 1..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.
| ||
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).
| ||||
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 | 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.
| |||
contact | C | 0..* | BackboneElement | 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. Unordered, Open, by id(Value) 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.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.
| |||
extension | 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.
| |||
modifierExtension | Σ ?! | 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.
| ||
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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| |||
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.
| |||
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.
| |||
extension | 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 Mappings
| |||
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 Mappings
| ||
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.
| ||
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).
| ||
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.
| ||
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.
| ||
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.
| ||
period | Σ | 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.
| ||
telecom | 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.
| |||
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.
| |||
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.
| |||
extension | 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 Mappings
| |||
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 ExamplesGeneral 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. The type of an address (physical / postal) ExamplesGeneral 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. 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. 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. 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. 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).
| ||
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. 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. General GBRMappings
| ||
period | Σ | 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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
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. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| |||
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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
period | 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.
| |||
nextOfKin | S C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPatient.contact:nextOfKinShort 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.
| ||
id | 1..1 | stringFixed Value | Element idPatient.contact:nextOfKin.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. patient.contact-nokMappings
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
relationship | 1..2 | CodeableConceptBinding | Element idPatient.contact:nextOfKin.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. Unordered, Open, by text(Value) BindingThe nature of the relationship between a patient and a contact person for that patient. Mappings
| |||
nokIndicator | S | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicatorShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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.contact:nextOfKin.relationship:nokIndicator.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 | Coding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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.contact:nextOfKin.relationship:nokIndicator.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 | uriFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. https://fhir.hl7.org.uk/CareConnect-PersonRelationshipType-1Mappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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 | codeFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. 04Mappings
| ||
display | Σ | 1..1 | stringFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. Next of kinMappings
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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 | Σ | 1..1 | stringFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. Next of kinMappings
| ||
nokRelationship | S | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokRelationshipShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokRelationship.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.contact:nextOfKin.relationship:nokRelationship.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokRelationship.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.
| ||
text | Σ | 1..1 | stringPattern | Element idPatient.contact:nextOfKin.relationship:nokRelationship.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. Family Relationship e.g. PartnerMappings
| ||
name | S | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 Mappings
| |||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 Mappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
telecom | S | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
address | S | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 ExamplesGeneral homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. 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:nextOfKin.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. General 137 Nowhere StreetGeneral 120, Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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).
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132General LS21 1PTMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. General GBRMappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| |||
organization | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
period | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
carer | S C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPatient.contact:carerShort 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.
| ||
id | 1..1 | stringFixed Value | Element idPatient.contact:carer.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. patient.contact-carerMappings
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
relationship | 1..2 | CodeableConceptBinding | Element idPatient.contact:carer.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. Unordered, Open, by text(Value) BindingThe nature of the relationship between a patient and a contact person for that patient. Mappings
| |||
carerIndicator | S | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicatorShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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.contact:carer.relationship:carerIndicator.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 | Coding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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.contact:carer.relationship:carerIndicator.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 | uriFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. https://fhir.hl7.org.uk/ValueSet/CareConnect-PersonRelationshipType-1Mappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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 | codeFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. 20Mappings
| ||
display | Σ | 1..1 | stringFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. CarerMappings
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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 | Σ | 1..1 | stringFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. CarerMappings
| ||
carerRelationship | S | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerRelationshipShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerRelationship.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.contact:carer.relationship:carerRelationship.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerRelationship.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.
| ||
text | Σ | 1..1 | stringPattern | Element idPatient.contact:carer.relationship:carerRelationship.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. Family Relationship e.g. SonMappings
| ||
name | S | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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 Mappings
| |||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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 Mappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
telecom | S | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
address | S | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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 ExamplesGeneral homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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. 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:carer.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. General 137 Nowhere StreetGeneral 120, Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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. General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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).
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132General LS21 1PTMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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. General GBRMappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:carer.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| |||
organization | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.contact:carer.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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
period | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
animal | Σ ?! | 0..0 | BackboneElement | Element idPatient.animalShort description This patient is known to be an animal (non-human) DefinitionThis patient is known to be an animal. Cannot refer a deceased patient to Social Care for a Supported Discharge The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).
| ||
communication | 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.
| |||
generalPractitioner | S | 0..1 | Reference(CareConnect-SHD-Practitioner-1) | 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-SHD-Practitioner-1) Mappings
| ||
managingOrganization | Σ | 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) Mappings
| ||
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'.
| ||
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.
| |||
extension | 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.
| |||
modifierExtension | Σ ?! | 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.
| ||
other | Σ | 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) Mappings
| ||
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. The type of link between this patient resource and another patient resource. Mappings
|
Hybrid
CareConnect-SHD-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 | Σ | 0..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. | ||
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. | ||
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. | ||
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
| |||
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: dom-1 Mappings
| ||
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 | 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) Mappings
| |||
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 | S C | 0..1 | Extension(Complex) | 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
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.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 | Element idPatient.extension:nhsCommunication.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
| ||
language | S C | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:languageShort description Languages which may be used for communication Alternate namesextensions, user content DefinitionLanguages 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. 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.extension:nhsCommunication.extension:language.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:nhsCommunication.extension:language.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:nhsCommunication.extension:language.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
languageMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:language.value[x]:valueCodeableConceptShort description Languages which may be used for communication DefinitionLanguages which may be used for communication. A stream of bytes, base64 encoded Human Language Care Connect Human Language (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.extension:nhsCommunication.extension:language.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.extension:nhsCommunication.extension:language.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:language.value[x]: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.
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:language.valueCodeableConcept: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.
| ||
preferred | S C | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:preferredShort description Language preference indicator 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. 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.extension:nhsCommunication.extension:preferred.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:nhsCommunication.extension:preferred.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:nhsCommunication.extension:preferred.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
preferredMappings
| |||
valueBoolean | 1..1 | booleanFixed Value | Element idPatient.extension:nhsCommunication.extension:preferred.valueBoolean:valueBooleanShort description Indicates whether or not this language is preferred (over other languages up a certain level) DefinitionIndicates whether or not this language is preferred (over other languages up a certain level) A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
trueMappings
| |||
modeOfCommunication | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:modeOfCommunicationShort description Mode of communication for the selected language 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. 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.extension:nhsCommunication.extension:modeOfCommunication.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:nhsCommunication.extension:modeOfCommunication.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:nhsCommunication.extension:modeOfCommunication.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
modeOfCommunicationMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConceptShort description A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. DefinitionA valueset to describe the mode the patient can communicate in, representing the method of expression of the language.. A stream of bytes, base64 encoded Language Ability Mode Care Connect Language Ability Mode (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
communicationProficiency | C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:communicationProficiencyShort description The level of proficiency in communicating a language 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. 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.extension:nhsCommunication.extension:communicationProficiency.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:nhsCommunication.extension:communicationProficiency.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:nhsCommunication.extension:communicationProficiency.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
communicationProficiencyMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConceptShort description A valueset to describe the level of proficiency in communicating a language DefinitionA valueset to describe the level of proficiency in communicating a language. A stream of bytes, base64 encoded Language Ability Proficiency Care Connect Language Ability Proficiency (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
interpreterRequired | S C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:interpreterRequiredShort description Interpreter preference indicator 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. 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.extension:nhsCommunication.extension:interpreterRequired.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:nhsCommunication.extension:interpreterRequired.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:nhsCommunication.extension:interpreterRequired.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
interpreterRequiredMappings
| |||
valueBoolean | 1..1 | boolean | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:interpreterRequired.valueBoolean:valueBooleanShort description Indicates whether an interpreter is required for communication purposes DefinitionIndicates whether an interpreter is required for communication purposes- True / False? A stream of bytes, base64 encoded The 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:nhsCommunication.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-NHSCommunication-1Mappings
| |||
value[x] | 0..0 | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.value[x]Short description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded The 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 | ?! | 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.
| ||
identifier | Σ | 0..* | 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) Mappings
| ||
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.
| ||
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.
| |||
extension | 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 Mappings
| |||
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
| ||
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 . Fixed valueofficialMappings
| ||
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) Mappings
| ||
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. https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patientMappings
| ||
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. General 123456General 1234567890Mappings
| ||
period | Σ | 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.
| ||
assigner | Σ | 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) Mappings
| ||
localIdentifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier:localIdentifierShort description An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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:localIdentifier.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
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.identifier:localIdentifier.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 . Fixed valuesecondaryMappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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) Mappings
| ||
system | Σ | 1..1 | uriPattern | Element idPatient.identifier:localIdentifier.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. http://www.acme.com/identifiers/patientExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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.
| ||
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. trueMappings
| ||
name | Σ | 0..* | 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) Mappings
| ||
official | S Σ | 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.
| ||
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.
| |||
extension | 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 Mappings
| |||
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 Fixed valueofficialMappings
| ||
text | Σ | 0..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.
| ||
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).
| ||
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.
| ||
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.
| ||
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.
| ||
period | Σ | 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.
| ||
telecom | Σ | 0..* | ContactPoint | 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). Unordered, Open, by system(Value), use(Value) Mappings
| ||
(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.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.
| |||
extension | 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 Mappings
| |||
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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Mappings
| ||
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.
| ||
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 Mappings
| ||
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.
| ||
period | Σ | 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.
| ||
homePhone | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:homePhoneShort 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).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homePhone.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.telecom:homePhone.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homePhone.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed valuephoneMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homePhone.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homePhone.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 Fixed valuehomeMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:homePhone.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:homePhone.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
mobilePhone | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:mobilePhoneShort 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).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.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.telecom:mobilePhone.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:mobilePhone.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed valuephoneMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:mobilePhone.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 Fixed valuemobileMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
homeEmail | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:homeEmailShort 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).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.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.telecom:homeEmail.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homeEmail.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed value
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homeEmail.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 Fixed valuehomeMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
gender | S Σ | 1..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) Mappings
| ||
birthDate | S Σ | 1..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).
| ||
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) | |||
extension | 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 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) | |||
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 DefinitionThe actual value | ||||
deceased[x] | Σ ?! | 0..0 | 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.
| |||
address | Σ | 0..* | Address | 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. Unordered, Open, by use(Value) Mappings
| ||
(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.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.
| |||
extension | 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 Mappings
| |||
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 ExamplesGeneral 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. The type of an address (physical / postal) ExamplesGeneral 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. 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. 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. 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. 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).
| ||
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. 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. General GBRMappings
| ||
period | Σ | 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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
homeAddress | S Σ | 1..1 | Address | There are no (further) constraints on this element Element idPatient.address:homeAddressShort 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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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.address:homeAddress.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
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.address:homeAddress.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 Fixed valuehomeExamples General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General 137 Nowhere Street, Erewhon 9132General 42 Grove Street, Overtown, West Yorkshire, LS21 1PFMappings
| ||
line | Σ | 2..5 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General 137 Nowhere StreetGeneral 42 Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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).
| ||
postalCode | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132General LS21 1PFMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General GBRMappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
maritalStatus | S | 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. The domestic partnership status of a person. Marital Status Codes (required) Mappings
| ||
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.
| |||
extension | 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 Mappings
| |||
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.
| ||
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.
| |||
extension | 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 Mappings
| |||
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. 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.
| ||
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.
| ||
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.
| ||
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.
| ||
text | Σ | 1..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.
| ||
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).
| ||||
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 | 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.
| |||
contact | C | 0..* | BackboneElement | 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. Unordered, Open, by id(Value) 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.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.
| |||
extension | 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.
| |||
modifierExtension | Σ ?! | 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.
| ||
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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| |||
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.
| |||
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.
| |||
extension | 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 Mappings
| |||
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 Mappings
| ||
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.
| ||
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).
| ||
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.
| ||
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.
| ||
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.
| ||
period | Σ | 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.
| ||
telecom | 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.
| |||
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.
| |||
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.
| |||
extension | 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 Mappings
| |||
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 ExamplesGeneral 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. The type of an address (physical / postal) ExamplesGeneral 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. 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. 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. 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. 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).
| ||
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. 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. General GBRMappings
| ||
period | Σ | 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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
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. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| |||
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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
period | 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.
| |||
nextOfKin | S C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPatient.contact:nextOfKinShort 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.
| ||
id | 1..1 | stringFixed Value | Element idPatient.contact:nextOfKin.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. patient.contact-nokMappings
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
relationship | 1..2 | CodeableConceptBinding | Element idPatient.contact:nextOfKin.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. Unordered, Open, by text(Value) BindingThe nature of the relationship between a patient and a contact person for that patient. Mappings
| |||
nokIndicator | S | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicatorShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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.contact:nextOfKin.relationship:nokIndicator.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 | Coding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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.contact:nextOfKin.relationship:nokIndicator.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 | uriFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. https://fhir.hl7.org.uk/CareConnect-PersonRelationshipType-1Mappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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 | codeFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. 04Mappings
| ||
display | Σ | 1..1 | stringFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. Next of kinMappings
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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 | Σ | 1..1 | stringFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. Next of kinMappings
| ||
nokRelationship | S | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokRelationshipShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokRelationship.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.contact:nextOfKin.relationship:nokRelationship.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokRelationship.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.
| ||
text | Σ | 1..1 | stringPattern | Element idPatient.contact:nextOfKin.relationship:nokRelationship.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. Family Relationship e.g. PartnerMappings
| ||
name | S | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 Mappings
| |||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 Mappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
telecom | S | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
address | S | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 ExamplesGeneral homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. 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:nextOfKin.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. General 137 Nowhere StreetGeneral 120, Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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).
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132General LS21 1PTMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. General GBRMappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| |||
organization | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
period | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
carer | S C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPatient.contact:carerShort 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.
| ||
id | 1..1 | stringFixed Value | Element idPatient.contact:carer.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. patient.contact-carerMappings
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
relationship | 1..2 | CodeableConceptBinding | Element idPatient.contact:carer.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. Unordered, Open, by text(Value) BindingThe nature of the relationship between a patient and a contact person for that patient. Mappings
| |||
carerIndicator | S | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicatorShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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.contact:carer.relationship:carerIndicator.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 | Coding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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.contact:carer.relationship:carerIndicator.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 | uriFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. https://fhir.hl7.org.uk/ValueSet/CareConnect-PersonRelationshipType-1Mappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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 | codeFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. 20Mappings
| ||
display | Σ | 1..1 | stringFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. CarerMappings
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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 | Σ | 1..1 | stringFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. CarerMappings
| ||
carerRelationship | S | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerRelationshipShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerRelationship.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.contact:carer.relationship:carerRelationship.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerRelationship.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.
| ||
text | Σ | 1..1 | stringPattern | Element idPatient.contact:carer.relationship:carerRelationship.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. Family Relationship e.g. SonMappings
| ||
name | S | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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 Mappings
| |||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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 Mappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
telecom | S | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
address | S | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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 ExamplesGeneral homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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. 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:carer.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. General 137 Nowhere StreetGeneral 120, Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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. General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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).
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132General LS21 1PTMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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. General GBRMappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:carer.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| |||
organization | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.contact:carer.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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
period | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
animal | Σ ?! | 0..0 | BackboneElement | Element idPatient.animalShort description This patient is known to be an animal (non-human) DefinitionThis patient is known to be an animal. Cannot refer a deceased patient to Social Care for a Supported Discharge The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).
| ||
communication | 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.
| |||
generalPractitioner | S | 0..1 | Reference(CareConnect-SHD-Practitioner-1) | 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-SHD-Practitioner-1) Mappings
| ||
managingOrganization | Σ | 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) Mappings
| ||
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'.
| ||
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.
| |||
extension | 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.
| |||
modifierExtension | Σ ?! | 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.
| ||
other | Σ | 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) Mappings
| ||
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. The type of link between this patient resource and another patient resource. Mappings
|
Snapshot (default)
CareConnect-SHD-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 | Σ | 0..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. | ||
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. | ||
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. | ||
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
| |||
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: dom-1 Mappings
| ||
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 | 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) Mappings
| |||
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 | S C | 0..1 | Extension(Complex) | 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
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.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 | Element idPatient.extension:nhsCommunication.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
| ||
language | S C | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:languageShort description Languages which may be used for communication Alternate namesextensions, user content DefinitionLanguages 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. 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.extension:nhsCommunication.extension:language.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:nhsCommunication.extension:language.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:nhsCommunication.extension:language.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
languageMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:language.value[x]:valueCodeableConceptShort description Languages which may be used for communication DefinitionLanguages which may be used for communication. A stream of bytes, base64 encoded Human Language Care Connect Human Language (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.extension:nhsCommunication.extension:language.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.extension:nhsCommunication.extension:language.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:language.value[x]: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.
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:language.valueCodeableConcept: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.
| ||
preferred | S C | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:preferredShort description Language preference indicator 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. 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.extension:nhsCommunication.extension:preferred.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:nhsCommunication.extension:preferred.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:nhsCommunication.extension:preferred.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
preferredMappings
| |||
valueBoolean | 1..1 | booleanFixed Value | Element idPatient.extension:nhsCommunication.extension:preferred.valueBoolean:valueBooleanShort description Indicates whether or not this language is preferred (over other languages up a certain level) DefinitionIndicates whether or not this language is preferred (over other languages up a certain level) A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
trueMappings
| |||
modeOfCommunication | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:modeOfCommunicationShort description Mode of communication for the selected language 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. 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.extension:nhsCommunication.extension:modeOfCommunication.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:nhsCommunication.extension:modeOfCommunication.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:nhsCommunication.extension:modeOfCommunication.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
modeOfCommunicationMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConceptShort description A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. DefinitionA valueset to describe the mode the patient can communicate in, representing the method of expression of the language.. A stream of bytes, base64 encoded Language Ability Mode Care Connect Language Ability Mode (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
communicationProficiency | C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:communicationProficiencyShort description The level of proficiency in communicating a language 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. 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.extension:nhsCommunication.extension:communicationProficiency.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:nhsCommunication.extension:communicationProficiency.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:nhsCommunication.extension:communicationProficiency.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
communicationProficiencyMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConceptShort description A valueset to describe the level of proficiency in communicating a language DefinitionA valueset to describe the level of proficiency in communicating a language. A stream of bytes, base64 encoded Language Ability Proficiency Care Connect Language Ability Proficiency (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
interpreterRequired | S C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:interpreterRequiredShort description Interpreter preference indicator 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. 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.extension:nhsCommunication.extension:interpreterRequired.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:nhsCommunication.extension:interpreterRequired.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:nhsCommunication.extension:interpreterRequired.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
interpreterRequiredMappings
| |||
valueBoolean | 1..1 | boolean | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.extension:interpreterRequired.valueBoolean:valueBooleanShort description Indicates whether an interpreter is required for communication purposes DefinitionIndicates whether an interpreter is required for communication purposes- True / False? A stream of bytes, base64 encoded The 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:nhsCommunication.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-NHSCommunication-1Mappings
| |||
value[x] | 0..0 | There are no (further) constraints on this element Element idPatient.extension:nhsCommunication.value[x]Short description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded The 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 | ?! | 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.
| ||
identifier | Σ | 0..* | 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) Mappings
| ||
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.
| ||
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.
| |||
extension | 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 Mappings
| |||
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
| ||
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 . Fixed valueofficialMappings
| ||
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) Mappings
| ||
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. https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patientMappings
| ||
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. General 123456General 1234567890Mappings
| ||
period | Σ | 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.
| ||
assigner | Σ | 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) Mappings
| ||
localIdentifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier:localIdentifierShort description An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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:localIdentifier.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
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.identifier:localIdentifier.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 . Fixed valuesecondaryMappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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) Mappings
| ||
system | Σ | 1..1 | uriPattern | Element idPatient.identifier:localIdentifier.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. http://www.acme.com/identifiers/patientExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:localIdentifier.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.
| ||
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. trueMappings
| ||
name | Σ | 0..* | 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) Mappings
| ||
official | S Σ | 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.
| ||
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.
| |||
extension | 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 Mappings
| |||
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 Fixed valueofficialMappings
| ||
text | Σ | 0..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.
| ||
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).
| ||
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.
| ||
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.
| ||
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.
| ||
period | Σ | 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.
| ||
telecom | Σ | 0..* | ContactPoint | 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). Unordered, Open, by system(Value), use(Value) Mappings
| ||
(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.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.
| |||
extension | 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 Mappings
| |||
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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Mappings
| ||
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.
| ||
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 Mappings
| ||
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.
| ||
period | Σ | 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.
| ||
homePhone | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:homePhoneShort 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).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homePhone.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.telecom:homePhone.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homePhone.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed valuephoneMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homePhone.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homePhone.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 Fixed valuehomeMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:homePhone.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:homePhone.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
mobilePhone | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:mobilePhoneShort 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).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.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.telecom:mobilePhone.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:mobilePhone.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed valuephoneMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:mobilePhone.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 Fixed valuemobileMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:mobilePhone.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
homeEmail | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:homeEmailShort 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).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.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.telecom:homeEmail.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homeEmail.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed value
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:homeEmail.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 Fixed valuehomeMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:homeEmail.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
gender | S Σ | 1..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) Mappings
| ||
birthDate | S Σ | 1..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).
| ||
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) | |||
extension | 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 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) | |||
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 DefinitionThe actual value | ||||
deceased[x] | Σ ?! | 0..0 | 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.
| |||
address | Σ | 0..* | Address | 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. Unordered, Open, by use(Value) Mappings
| ||
(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.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.
| |||
extension | 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 Mappings
| |||
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 ExamplesGeneral 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. The type of an address (physical / postal) ExamplesGeneral 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. 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. 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. 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. 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).
| ||
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. 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. General GBRMappings
| ||
period | Σ | 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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
homeAddress | S Σ | 1..1 | Address | There are no (further) constraints on this element Element idPatient.address:homeAddressShort 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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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.address:homeAddress.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
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.address:homeAddress.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 Fixed valuehomeExamples General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General 137 Nowhere Street, Erewhon 9132General 42 Grove Street, Overtown, West Yorkshire, LS21 1PFMappings
| ||
line | Σ | 2..5 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General 137 Nowhere StreetGeneral 42 Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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).
| ||
postalCode | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132General LS21 1PFMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General GBRMappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address:homeAddress.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
maritalStatus | S | 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. The domestic partnership status of a person. Marital Status Codes (required) Mappings
| ||
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.
| |||
extension | 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 Mappings
| |||
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.
| ||
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.
| |||
extension | 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 Mappings
| |||
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. 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.
| ||
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.
| ||
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.
| ||
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.
| ||
text | Σ | 1..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.
| ||
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).
| ||||
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 | 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.
| |||
contact | C | 0..* | BackboneElement | 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. Unordered, Open, by id(Value) 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.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.
| |||
extension | 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.
| |||
modifierExtension | Σ ?! | 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.
| ||
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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| |||
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.
| |||
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.
| |||
extension | 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 Mappings
| |||
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 Mappings
| ||
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.
| ||
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).
| ||
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.
| ||
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.
| ||
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.
| ||
period | Σ | 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.
| ||
telecom | 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.
| |||
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.
| |||
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.
| |||
extension | 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 Mappings
| |||
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 ExamplesGeneral 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. The type of an address (physical / postal) ExamplesGeneral 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. 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. 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. 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. 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).
| ||
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. 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. General GBRMappings
| ||
period | Σ | 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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
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. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| |||
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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
period | 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.
| |||
nextOfKin | S C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPatient.contact:nextOfKinShort 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.
| ||
id | 1..1 | stringFixed Value | Element idPatient.contact:nextOfKin.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. patient.contact-nokMappings
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
relationship | 1..2 | CodeableConceptBinding | Element idPatient.contact:nextOfKin.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. Unordered, Open, by text(Value) BindingThe nature of the relationship between a patient and a contact person for that patient. Mappings
| |||
nokIndicator | S | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicatorShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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.contact:nextOfKin.relationship:nokIndicator.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 | Coding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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.contact:nextOfKin.relationship:nokIndicator.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 | uriFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. https://fhir.hl7.org.uk/CareConnect-PersonRelationshipType-1Mappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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 | codeFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. 04Mappings
| ||
display | Σ | 1..1 | stringFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. Next of kinMappings
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokIndicator.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 | Σ | 1..1 | stringFixed Value | Element idPatient.contact:nextOfKin.relationship:nokIndicator.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. Next of kinMappings
| ||
nokRelationship | S | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokRelationshipShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokRelationship.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.contact:nextOfKin.relationship:nokRelationship.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.relationship:nokRelationship.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.
| ||
text | Σ | 1..1 | stringPattern | Element idPatient.contact:nextOfKin.relationship:nokRelationship.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. Family Relationship e.g. PartnerMappings
| ||
name | S | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 Mappings
| |||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 Mappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
telecom | S | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
address | S | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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 ExamplesGeneral homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. 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:nextOfKin.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. General 137 Nowhere StreetGeneral 120, Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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).
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132General LS21 1PTMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. General GBRMappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| |||
organization | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
period | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:nextOfKin.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.
| |||
carer | S C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPatient.contact:carerShort 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.
| ||
id | 1..1 | stringFixed Value | Element idPatient.contact:carer.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. patient.contact-carerMappings
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
relationship | 1..2 | CodeableConceptBinding | Element idPatient.contact:carer.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. Unordered, Open, by text(Value) BindingThe nature of the relationship between a patient and a contact person for that patient. Mappings
| |||
carerIndicator | S | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicatorShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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.contact:carer.relationship:carerIndicator.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 | Coding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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.contact:carer.relationship:carerIndicator.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 | uriFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. https://fhir.hl7.org.uk/ValueSet/CareConnect-PersonRelationshipType-1Mappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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 | codeFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. 20Mappings
| ||
display | Σ | 1..1 | stringFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. CarerMappings
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerIndicator.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 | Σ | 1..1 | stringFixed Value | Element idPatient.contact:carer.relationship:carerIndicator.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. CarerMappings
| ||
carerRelationship | S | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerRelationshipShort 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. The nature of the relationship between a patient and a contact person for that patient. Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerRelationship.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.contact:carer.relationship:carerRelationship.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPatient.contact:carer.relationship:carerRelationship.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.
| ||
text | Σ | 1..1 | stringPattern | Element idPatient.contact:carer.relationship:carerRelationship.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. Family Relationship e.g. SonMappings
| ||
name | S | 1..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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 Mappings
| |||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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 Mappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
telecom | S | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
address | S | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact:carer.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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 ExamplesGeneral homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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. 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:carer.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. General 137 Nowhere StreetGeneral 120, Grove StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonGeneral OvertownMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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. General MadisonGeneral West YorkshireMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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).
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132General LS21 1PTMappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact:carer.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. General GBRMappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:carer.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact:carer.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. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| |||
organization | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPatient.contact:carer.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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
period | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact:carer.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.
| |||
animal | Σ ?! | 0..0 | BackboneElement | Element idPatient.animalShort description This patient is known to be an animal (non-human) DefinitionThis patient is known to be an animal. Cannot refer a deceased patient to Social Care for a Supported Discharge The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).
| ||
communication | 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.
| |||
generalPractitioner | S | 0..1 | Reference(CareConnect-SHD-Practitioner-1) | 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-SHD-Practitioner-1) Mappings
| ||
managingOrganization | Σ | 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) Mappings
| ||
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'.
| ||
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.
| |||
extension | 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.
| |||
modifierExtension | Σ ?! | 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.
| ||
other | Σ | 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) Mappings
| ||
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. The type of link between this patient resource and another patient resource. Mappings
|
Patient Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-SHD-Patient-1 profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
Patient.extension[nhsCommunication] | 0..1 | Extension-CareConnect-NHSCommunication-1 | Optional element to share details of the the patient's communication preferences. |
Patient.extension[nhsCommunication] |
1..1 | string | Plain text representation of the Patients Preferred Language. |
Patient.extension[nhsCommunication] |
1..1 | boolean | Fixed Value: "TRUE" |
Patient.extension[nhsCommunication] |
0..1 | boolean | Optional elment to confirm if an Interpreter is required for English |
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 and MUST include a coding.system, coding.code and coding.display from the ValueSet Binding CareConnect-NHSNumberVerificationStatus-1 |
Patient.identifier[localIdentifier] | 0..1 | identifier | Constraint: For the Local Identifier: Patient.identifier.use = 'secondary' |
Patient.name | 1..* | HumanName | Constraint: Multiple names may be provided, however one SHALL be the official name, i.e. Patient.name.use = 'official'Patient.identifier.system = {Local System}Patient.identifier.value={Hospital Number} |
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.telecom | 0..* | ContactPoint | Constraint: Multiple may be provided, however Home Phone, Mobile Phone and Home Email MUST BE SUPPORTED |
Patient.telecom[homePhone] | 0..1 | ContactPoint | Constraint: For homePhone: Patient.telecom.system = 'phone'Patient.telecom.value = {Phone Number}Patient.telecom.use = 'home' |
Patient.telecom[mobilePhone] | 0..1 | ContactPoint | Constraint: For mobilePhone: Patient.telecom.system = 'phone'Patient.telecom.value = {Phone Number}Patient.telecom.use = 'mobile' |
Patient.telecom[homeEmail] | 0..1 | ContactPoint | Constraint: For homeEmail: Patient.telecom.system = 'email'Patient.telecom.value = {Email Address}Patient.telecom.use = 'home' |
Patient.gender | 1..1 | code | Binding AdministrativeGender |
Patient.birthdate | 1..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.address | 0..* | Address | Constraint: Multiple addresses may be provided, however one SHALL be the main home address of the patient. |
Patient.address[homeAddress] | 1..1 | Address | Constraint: For homeAddress: Patient.address.use = 'home' |
Patient.address[homeAddress].line | 2..5 | string | Address lines should be provided in Patient.address.line element for consistency as many source systems do not have he required detail to distinguish between city, district etc. A minimum of 2 lines should be provided as this is a requirement of many Social Care Systems. |
Patient.address[homeAddress].postCode | 1..1 | string | Post Code SHALL be provided for the home address |
Patient.maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient |
Patient.maritalStatus.text | 1..1 | string | If Patient maritalStatus is provided, maritalStatus text MUST also be provided. |
Patient.contact | 0..* | BackboneElement | Constraint: Multiple contacts may be provided, however implementors MUST SUPPORT Next of Kin and Carer. |
Patient.contact[nextOfKin] | 0..1 | BackboneElement | Optional element for the contact details of the Next of Kin |
Patient.contact[nextOfKin] |
1..1 | Coding | Constraint: A nextOfKin contact MUST have a relationship for the nokIndicator. This is a fixed coding so that FHIRPath can be used to retrieve the distinguish the Next of Kin from any other contact. Fixed Values: Patient.contact.relationship.coding.system = 'https |
Patient.contact[nextOfKin] |
0..1 | string | In addition to the relationship for the nokIndicator, an second Patient.contact.relationship may be included to share plain text details that add more context e.g. Sister, Brother, Friend. |
Patient.contact[nextOfKin].name | 1..1 | HumanName | Constraint: A nextOfKin contact MUST have a name with a Patient.contact.name.text |
Patient.contact[nextOfKin].telecom | 0..* | ContactPoint | Optional data element for the the contact points for a given contact (e.g. phone, fax, email, etc.) |
Patient.contact[nextOfKin].address | 0..1 | Address | Optional data element for an address for the contact |
Patient.contact[carer] | 0..1 | BackboneElement | Optional element for the contact details of the Carer |
Patient.contact[carer] |
1..1 | Coding | Constraint: A carer contact MUST have a relationship for the carerIndicator. This is a fixed coding so that FHIRPath can be used to retrieve the distinguish the Carer from any other contact. Fixed Values: Patient.contact.relationship.coding.system = 'https |
Patient.contact[carer] |
0..1 | string | In addition to the relationship for the carerIndicator, an second Patient.contact.relationship may be included to share plain text details that add more context e.g. Sister, Brother, Friend. |
Patient.contact[carer].name | 1..1 | HumanName | Constraint: A carer contact MUST have a name with a Patient.contact.name.text |
Patient.contact[carer].telecom | 0..* | ContactPoint | Optional data element for the the contact points for a given contact (e.g. phone, fax, email, etc.) |
Patient.contact[carer].address | 0..1 | Address | Optional data element for an address for the contact |
Patient.generalPractitioner | 0..1 | Reference (CareConnect-SHD-Practitioner-1) | Reference to Practitioner resource relating to the Patient's GP |
CareConnect-SHD-Encounter-1
This is the StructureDefinition overview for the CareConnect-SHD-Encounter-1
The official URL for this profile is: https
Differential
CareConnect-SHD-Encounter-1 (Encounter) | C | CareConnect-Encounter-1 | There are no (further) constraints on this element Element idEncounterShort description An interaction during which services are provided to the patient Alternate namesVisit DefinitionAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idEncounter.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 idEncounter.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
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEncounter.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 idEncounter.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 idEncounter.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
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idEncounter.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 | Element idEncounter.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
| ||
encounterTransport | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idEncounter.extension:encounterTransportShort 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EncounterTransport-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
outcomeOfAttendance | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.extension:outcomeOfAttendanceShort 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-OutcomeOfAttendance-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
emergencyCareDischargeStatus | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.extension:emergencyCareDischargeStatusShort 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
medicallyFitForDischarge | S C | 1..1 | Extension(Complex) | Element idEncounter.extension:medicallyFitForDischargeShort description Medically Fit for Discharge Alternate namesextensions, user content DefinitionWhether the patient is fit for discharge, i.e. all health/medical activities required fro a safe discharge have been completed 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.nottinghamshire.gov.uk/STU3/StructureDefinition/Extension-SHD-MedicallyFitDetails 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 idEncounter.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 | S Σ | 1..1 | Identifier | Element idEncounter.identifierShort description Identifier(s) by which this encounter is known DefinitionIdentifier(s) by which this encounter is known. The consumer (e.g. Hospital) must provide a unique identifier for encounter - the same identifier willl also need to be referenced when sharing any updates (e.g. chnage to Predicted Discharge Date) 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 idEncounter.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 idEncounter.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 idEncounter.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 idEncounter.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
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idEncounter.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 | Σ | 1..1 | string | There are no (further) constraints on this element Element idEncounter.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 idEncounter.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
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idEncounter.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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | S Σ ?! | 1..1 | codeBinding | Element idEncounter.statusShort description planned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +. in-progress = use for initial referral and when sharing updates of an exising case finished = use when communicating the patient has been discharged normally (i.e. to social care) cancelled = use when communicating the patient has died/self-discharged or the referral is no longer required Current state of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
statusHistory | S | 0..* | BackboneElement | Element idEncounter.statusHistoryShort description List of past encounter statuses DefinitionThe status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them. Encounter MUST have a statusHistory for the previous status if Encounter.status = 'cancelled' 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 idEncounter.statusHistory.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 | Element idEncounter.statusHistory.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
| ||
encounterStatusChangeReason | C | 1..1 | Extension(CodeableConcept) | Element idEncounter.statusHistory.extension:encounterStatusChangeReasonShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.statusHistory.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
| ||
status | 1..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.statusHistory.statusShort description planned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +. Note that FHIR strings may not exceed 1MB in size Current state of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
period | C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.statusHistory.periodShort description The time that the episode was in the specified status DefinitionThe time that the episode was in the specified status. 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
| ||
class | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.classShort description Classification of the encounter DefinitionClassification of the encounter. 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. Classification of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
classHistory | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.classHistoryShort description List of past encounter classes DefinitionThe class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient. 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 idEncounter.classHistory.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 idEncounter.classHistory.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 idEncounter.classHistory.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
| ||
class | 1..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.classHistory.classShort description Classification of the encounter DefinitionClassification of the encounter. 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. Classification of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
period | C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.classHistory.periodShort description The time that the episode was in the specified class DefinitionThe time that the episode was in the specified class. 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
| ||
type | S Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.typeShort description Specific type of encounter DefinitionSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). Since there are many ways to further classify encounters, this element is 0..*. The type of encounter 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 idEncounter.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 idEncounter.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 | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idEncounter.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. Unordered, Open, 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 idEncounter.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.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 Mappings
| |||
system | Σ | 1..1 | uriFixed Value | Element idEncounter.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. https://fhir.nottinghamshire.gov.uk/encounter/typeMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.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.
| ||
code | Σ | 1..1 | codeFixed Value | Element idEncounter.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. supported-dischargeMappings
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.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.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idEncounter.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.
| ||
snomedCT | Σ | 0..0 | CodingBinding | There are no (further) constraints on this element Element idEncounter.type.coding:snomedCTShort 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. A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). Care Connect Encounter Type (extensible) 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 idEncounter.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
| ||
priority | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.priorityShort description Indicates the urgency of the encounter DefinitionIndicates the urgency of the encounter. 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. Indicates the urgency of the encounter. v3 Code System ActPriority (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
subject | Σ C | 0..1 | Reference(Group | CareConnect-Patient-1) | There are no (further) constraints on this element Element idEncounter.subjectShort description The patient ro group present at the encounter Alternate namespatient DefinitionThe patient ro group present at the encounter. While the encounter is always about the patient, the patient may not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked). Reference(Group | CareConnect-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
episodeOfCare | Σ C | 0..* | Reference(EpisodeOfCare) | There are no (further) constraints on this element Element idEncounter.episodeOfCareShort description Episode(s) of care that this encounter should be recorded against DefinitionWhere a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
incomingReferral | C | 0..* | Reference(ReferralRequest) | There are no (further) constraints on this element Element idEncounter.incomingReferralShort description The ReferralRequest that initiated this encounter DefinitionThe referral request this encounter satisfies (incoming referral). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
participant | S Σ | 0..1 | BackboneElement | Element idEncounter.participantShort description Lead Clinician DefinitionThe details of the person at the hospital who is leading the patient’s care. A reference to the Lead Clinician practitioner who accepts overall responsibility for the Patient's Encounter 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 idEncounter.participant.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 idEncounter.participant.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 idEncounter.participant.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
| ||
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.participant.typeShort description Role of participant in encounter DefinitionRole of participant in encounter. The participant type indicates how an individual partitipates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc. Role of participant in encounter ConditionsThe 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 idEncounter.participant.periodShort description Period of time during the encounter that the participant participated DefinitionThe period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period. 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
| ||
individual | Σ C | 1..1 | Reference(CareConnect-SHD-Practitioner-1) | Element idEncounter.participant.individualShort description Persons involved in the encounter other than the patient DefinitionPersons involved in the encounter other than the patient. 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-SHD-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
appointment | Σ C | 0..1 | Reference(Appointment) | There are no (further) constraints on this element Element idEncounter.appointmentShort description The appointment that scheduled this encounter DefinitionThe appointment that scheduled this encounter. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | S C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.periodShort description The start and end time of the encounter DefinitionThe start and end time of the encounter. If not (yet) known, the end of the Period may be omitted. 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 idEncounter.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.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 Mappings
| |||
start | Σ C | 1..1 | dateTime | Element idEncounter.period.startShort description Admission Date 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: per-1 Mappings
| ||
end | S Σ C | 0..1 | dateTime | Element idEncounter.period.endShort description Discharge Date (Planned/Actual) 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. If status = 'in-progress' this is the current Predicted Discharge Date (PDD). If status = 'cancelled' this is the last recorded Predicted Discharge Date (PDD). If status = 'finished' this is the Actual Discharge Date. The PDD SHOULD be shared if recorded on the source system, however as there will be occasions when it is not populated, period.end is NOT mandatory when status = 'in-progress' or 'cancelled'. The Actual Discharge Date MUST be shared when the Patient has been discharged, as such period.end IS mandatory when status = 'finished'. PDD may also be known as EDD or PDMS 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: per-1 Mappings
| ||
length | C | 0..1 | Duration | There are no (further) constraints on this element Element idEncounter.lengthShort description Quantity of time the encounter lasted (less time absent) DefinitionQuantity of time the encounter lasted. This excludes the time during leaves of absence. May differ from the time the Encounter.period lasted because of leave of absence. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reason | S Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.reasonShort description Reason the encounter takes place (code) Alternate namesIndication, Admission diagnosis DefinitionReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). Reason why the encounter takes place. Encounter Reason Codes (preferred) 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 idEncounter.reason.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 idEncounter.reason.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 idEncounter.reason.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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
snomedCT | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idEncounter.reason.coding:snomedCTShort 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 idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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
| ||
snomedCTDescriptionID | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idEncounter.reason.coding:snomedCT.extension:snomedCTDescriptionIDShort 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid ConditionsThe 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 idEncounter.reason.coding:snomedCT.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
http://snomed.info/sctMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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 | Σ | 1..1 | string | Element idEncounter.reason.textShort description Reason for Admission to Hospital DefinitionSummary of why the Patient was admitted to hospital. 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
| ||
diagnosis | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.diagnosisShort description The list of diagnosis relevant to this encounter DefinitionThe list of diagnosis relevant to this encounter. 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 idEncounter.diagnosis.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 idEncounter.diagnosis.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 idEncounter.diagnosis.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
| ||
condition | C | 1..1 | Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) | There are no (further) constraints on this element Element idEncounter.diagnosis.conditionShort description Reason the encounter takes place (resource) Alternate namesAdmission diagnosis, discharge diagnosis, indication DefinitionReason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
role | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.diagnosis.roleShort description Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) DefinitionRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …). 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 type of diagnosis this condition represents 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 idEncounter.diagnosis.rankShort description Ranking of the diagnosis (for each role type) DefinitionRanking of the diagnosis (for each role type). 32 bit number; for values larger than this, use decimal The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
account | C | 0..* | Reference(Account) | There are no (further) constraints on this element Element idEncounter.accountShort description The set of accounts that may be used for billing for this Encounter DefinitionThe set of accounts that may be used for billing for this Encounter. The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
hospitalization | 0..1 | BackboneElement | There are no (further) constraints on this element Element idEncounter.hospitalizationShort description Details about the admission to a healthcare service DefinitionDetails about the admission to a healthcare service. An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included. The duration recorded in the period of this encounter covers the entire scope of this hospitalization record. 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 idEncounter.hospitalization.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 idEncounter.hospitalization.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
| ||
admissionMethod | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.hospitalization.extension:admissionMethodShort 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AdmissionMethod-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
dischargeMethod | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.hospitalization.extension:dischargeMethodShort 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DischargeMethod-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 idEncounter.hospitalization.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
| ||
preAdmissionIdentifier | 0..1 | Identifier | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifierShort description Pre-admission identifier DefinitionPre-admission identifier. 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 idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier.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 | Σ | 1..1 | string | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier.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
| ||
origin | C | 0..1 | Reference(CareConnect-Location-1) | There are no (further) constraints on this element Element idEncounter.hospitalization.originShort description The location from which the patient came before admission DefinitionThe location from which the patient came before admission. 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-Location-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
admitSource | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.admitSourceShort description From where patient was admitted (physician referral, transfer) DefinitionFrom where patient was admitted (physician referral, transfer). 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 source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. NHS Data Model and Dictionary Source Of Admission (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
reAdmission | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmissionShort description The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission DefinitionWhether this hospitalization is a readmission and why if known. 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 reason for re-admission of this hospitalization encounter. v2 Re-Admission Indicator (example) 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 idEncounter.hospitalization.reAdmission.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 idEncounter.hospitalization.reAdmission.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 idEncounter.hospitalization.reAdmission.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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
snomedCT | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission.coding:snomedCTShort 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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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
| ||
snomedCTDescriptionID | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionIDShort 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid ConditionsThe 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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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
http://snomed.info/sctMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.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
| ||
dietPreference | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.dietPreferenceShort description Diet preferences reported by the patient DefinitionDiet preferences reported by the patient. Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter. For example a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive). Medical, cultural or ethical food preferences to help with catering requirements. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
specialCourtesy | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialCourtesyShort description Special courtesies (VIP, board member) DefinitionSpecial courtesies (VIP, board member). 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. Special courtesies ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
specialArrangement | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialArrangementShort description Wheelchair, translator, stretcher, etc. DefinitionAny special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things. 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. Special arrangements SpecialArrangements (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
destination | C | 0..1 | Reference(CareConnect-Location-1) | There are no (further) constraints on this element Element idEncounter.hospitalization.destinationShort description Location to which the patient is discharged DefinitionLocation to which the patient is discharged. 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-Location-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
dischargeDisposition | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.dischargeDispositionShort description Category or kind of location after discharge DefinitionCategory or kind of location after discharge. 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 destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. NHS Data Model and Dictionary Discharge Destination (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
location | S | 1..1 | BackboneElement | Element idEncounter.locationShort description Ward the Patient is located DefinitionList of locations where the patient has been during this encounter. Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". 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 idEncounter.location.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 idEncounter.location.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 idEncounter.location.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
| ||
location | C | 1..1 | Reference(CareConnect-SHD-Location-1) | Element idEncounter.location.locationShort description Location the encounter takes place DefinitionThe location where the encounter takes place. 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-SHD-Location-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | 0..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.location.statusShort description planned | active | reserved | completed DefinitionThe status of the participants' presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time. When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed. The status of the location. EncounterLocationStatus (required) ConditionsThe 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 idEncounter.location.periodShort description Time period during which the patient was present at the location DefinitionTime period during which the patient was present at the location. 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
| ||
serviceProvider | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idEncounter.serviceProviderShort description The custodian organization of this Encounter record DefinitionAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization. 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 Constraints
| ||
partOf | C | 0..1 | Reference(CareConnect-Encounter-1) | There are no (further) constraints on this element Element idEncounter.partOfShort description Another Encounter this encounter is part of DefinitionAnother Encounter of which this encounter is a part of (administratively or in time). This is also used for associating a child's encounter back to the mother's encounter. Refer to the Notes section in the Patient resource for further details. Reference(CareConnect-Encounter-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Hybrid
CareConnect-SHD-Encounter-1 (Encounter) | C | CareConnect-Encounter-1 | There are no (further) constraints on this element Element idEncounterShort description An interaction during which services are provided to the patient Alternate namesVisit DefinitionAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idEncounter.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 idEncounter.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
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEncounter.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 idEncounter.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 idEncounter.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
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idEncounter.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 | Element idEncounter.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
| ||
encounterTransport | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idEncounter.extension:encounterTransportShort 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EncounterTransport-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
outcomeOfAttendance | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.extension:outcomeOfAttendanceShort 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-OutcomeOfAttendance-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
emergencyCareDischargeStatus | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.extension:emergencyCareDischargeStatusShort 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
medicallyFitForDischarge | S C | 1..1 | Extension(Complex) | Element idEncounter.extension:medicallyFitForDischargeShort description Medically Fit for Discharge Alternate namesextensions, user content DefinitionWhether the patient is fit for discharge, i.e. all health/medical activities required fro a safe discharge have been completed 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.nottinghamshire.gov.uk/STU3/StructureDefinition/Extension-SHD-MedicallyFitDetails 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 idEncounter.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 | S Σ | 1..1 | Identifier | Element idEncounter.identifierShort description Identifier(s) by which this encounter is known DefinitionIdentifier(s) by which this encounter is known. The consumer (e.g. Hospital) must provide a unique identifier for encounter - the same identifier willl also need to be referenced when sharing any updates (e.g. chnage to Predicted Discharge Date) 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 idEncounter.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 idEncounter.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 idEncounter.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 idEncounter.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
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idEncounter.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 | Σ | 1..1 | string | There are no (further) constraints on this element Element idEncounter.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 idEncounter.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
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idEncounter.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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | S Σ ?! | 1..1 | codeBinding | Element idEncounter.statusShort description planned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +. in-progress = use for initial referral and when sharing updates of an exising case finished = use when communicating the patient has been discharged normally (i.e. to social care) cancelled = use when communicating the patient has died/self-discharged or the referral is no longer required Current state of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
statusHistory | S | 0..* | BackboneElement | Element idEncounter.statusHistoryShort description List of past encounter statuses DefinitionThe status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them. Encounter MUST have a statusHistory for the previous status if Encounter.status = 'cancelled' 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 idEncounter.statusHistory.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 | Element idEncounter.statusHistory.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
| ||
encounterStatusChangeReason | C | 1..1 | Extension(CodeableConcept) | Element idEncounter.statusHistory.extension:encounterStatusChangeReasonShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.statusHistory.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
| ||
status | 1..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.statusHistory.statusShort description planned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +. Note that FHIR strings may not exceed 1MB in size Current state of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
period | C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.statusHistory.periodShort description The time that the episode was in the specified status DefinitionThe time that the episode was in the specified status. 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
| ||
class | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.classShort description Classification of the encounter DefinitionClassification of the encounter. 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. Classification of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
classHistory | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.classHistoryShort description List of past encounter classes DefinitionThe class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient. 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 idEncounter.classHistory.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 idEncounter.classHistory.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 idEncounter.classHistory.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
| ||
class | 1..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.classHistory.classShort description Classification of the encounter DefinitionClassification of the encounter. 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. Classification of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
period | C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.classHistory.periodShort description The time that the episode was in the specified class DefinitionThe time that the episode was in the specified class. 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
| ||
type | S Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.typeShort description Specific type of encounter DefinitionSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). Since there are many ways to further classify encounters, this element is 0..*. The type of encounter 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 idEncounter.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 idEncounter.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 | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idEncounter.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. Unordered, Open, 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 idEncounter.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.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 Mappings
| |||
system | Σ | 1..1 | uriFixed Value | Element idEncounter.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. https://fhir.nottinghamshire.gov.uk/encounter/typeMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.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.
| ||
code | Σ | 1..1 | codeFixed Value | Element idEncounter.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. supported-dischargeMappings
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.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.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idEncounter.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.
| ||
snomedCT | Σ | 0..0 | CodingBinding | There are no (further) constraints on this element Element idEncounter.type.coding:snomedCTShort 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. A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). Care Connect Encounter Type (extensible) 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 idEncounter.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
| ||
priority | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.priorityShort description Indicates the urgency of the encounter DefinitionIndicates the urgency of the encounter. 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. Indicates the urgency of the encounter. v3 Code System ActPriority (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
subject | Σ C | 0..1 | Reference(Group | CareConnect-Patient-1) | There are no (further) constraints on this element Element idEncounter.subjectShort description The patient ro group present at the encounter Alternate namespatient DefinitionThe patient ro group present at the encounter. While the encounter is always about the patient, the patient may not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked). Reference(Group | CareConnect-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
episodeOfCare | Σ C | 0..* | Reference(EpisodeOfCare) | There are no (further) constraints on this element Element idEncounter.episodeOfCareShort description Episode(s) of care that this encounter should be recorded against DefinitionWhere a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
incomingReferral | C | 0..* | Reference(ReferralRequest) | There are no (further) constraints on this element Element idEncounter.incomingReferralShort description The ReferralRequest that initiated this encounter DefinitionThe referral request this encounter satisfies (incoming referral). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
participant | S Σ | 0..1 | BackboneElement | Element idEncounter.participantShort description Lead Clinician DefinitionThe details of the person at the hospital who is leading the patient’s care. A reference to the Lead Clinician practitioner who accepts overall responsibility for the Patient's Encounter 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 idEncounter.participant.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 idEncounter.participant.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 idEncounter.participant.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
| ||
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.participant.typeShort description Role of participant in encounter DefinitionRole of participant in encounter. The participant type indicates how an individual partitipates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc. Role of participant in encounter ConditionsThe 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 idEncounter.participant.periodShort description Period of time during the encounter that the participant participated DefinitionThe period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period. 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
| ||
individual | Σ C | 1..1 | Reference(CareConnect-SHD-Practitioner-1) | Element idEncounter.participant.individualShort description Persons involved in the encounter other than the patient DefinitionPersons involved in the encounter other than the patient. 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-SHD-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
appointment | Σ C | 0..1 | Reference(Appointment) | There are no (further) constraints on this element Element idEncounter.appointmentShort description The appointment that scheduled this encounter DefinitionThe appointment that scheduled this encounter. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | S C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.periodShort description The start and end time of the encounter DefinitionThe start and end time of the encounter. If not (yet) known, the end of the Period may be omitted. 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 idEncounter.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.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 Mappings
| |||
start | Σ C | 1..1 | dateTime | Element idEncounter.period.startShort description Admission Date 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: per-1 Mappings
| ||
end | S Σ C | 0..1 | dateTime | Element idEncounter.period.endShort description Discharge Date (Planned/Actual) 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. If status = 'in-progress' this is the current Predicted Discharge Date (PDD). If status = 'cancelled' this is the last recorded Predicted Discharge Date (PDD). If status = 'finished' this is the Actual Discharge Date. The PDD SHOULD be shared if recorded on the source system, however as there will be occasions when it is not populated, period.end is NOT mandatory when status = 'in-progress' or 'cancelled'. The Actual Discharge Date MUST be shared when the Patient has been discharged, as such period.end IS mandatory when status = 'finished'. PDD may also be known as EDD or PDMS 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: per-1 Mappings
| ||
length | C | 0..1 | Duration | There are no (further) constraints on this element Element idEncounter.lengthShort description Quantity of time the encounter lasted (less time absent) DefinitionQuantity of time the encounter lasted. This excludes the time during leaves of absence. May differ from the time the Encounter.period lasted because of leave of absence. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reason | S Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.reasonShort description Reason the encounter takes place (code) Alternate namesIndication, Admission diagnosis DefinitionReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). Reason why the encounter takes place. Encounter Reason Codes (preferred) 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 idEncounter.reason.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 idEncounter.reason.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 idEncounter.reason.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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
snomedCT | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idEncounter.reason.coding:snomedCTShort 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 idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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
| ||
snomedCTDescriptionID | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idEncounter.reason.coding:snomedCT.extension:snomedCTDescriptionIDShort 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid ConditionsThe 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 idEncounter.reason.coding:snomedCT.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
http://snomed.info/sctMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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 | Σ | 1..1 | string | Element idEncounter.reason.textShort description Reason for Admission to Hospital DefinitionSummary of why the Patient was admitted to hospital. 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
| ||
diagnosis | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.diagnosisShort description The list of diagnosis relevant to this encounter DefinitionThe list of diagnosis relevant to this encounter. 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 idEncounter.diagnosis.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 idEncounter.diagnosis.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 idEncounter.diagnosis.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
| ||
condition | C | 1..1 | Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) | There are no (further) constraints on this element Element idEncounter.diagnosis.conditionShort description Reason the encounter takes place (resource) Alternate namesAdmission diagnosis, discharge diagnosis, indication DefinitionReason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
role | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.diagnosis.roleShort description Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) DefinitionRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …). 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 type of diagnosis this condition represents 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 idEncounter.diagnosis.rankShort description Ranking of the diagnosis (for each role type) DefinitionRanking of the diagnosis (for each role type). 32 bit number; for values larger than this, use decimal The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
account | C | 0..* | Reference(Account) | There are no (further) constraints on this element Element idEncounter.accountShort description The set of accounts that may be used for billing for this Encounter DefinitionThe set of accounts that may be used for billing for this Encounter. The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
hospitalization | 0..1 | BackboneElement | There are no (further) constraints on this element Element idEncounter.hospitalizationShort description Details about the admission to a healthcare service DefinitionDetails about the admission to a healthcare service. An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included. The duration recorded in the period of this encounter covers the entire scope of this hospitalization record. 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 idEncounter.hospitalization.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 idEncounter.hospitalization.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
| ||
admissionMethod | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.hospitalization.extension:admissionMethodShort 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AdmissionMethod-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
dischargeMethod | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.hospitalization.extension:dischargeMethodShort 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DischargeMethod-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 idEncounter.hospitalization.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
| ||
preAdmissionIdentifier | 0..1 | Identifier | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifierShort description Pre-admission identifier DefinitionPre-admission identifier. 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 idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier.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 | Σ | 1..1 | string | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier.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
| ||
origin | C | 0..1 | Reference(CareConnect-Location-1) | There are no (further) constraints on this element Element idEncounter.hospitalization.originShort description The location from which the patient came before admission DefinitionThe location from which the patient came before admission. 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-Location-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
admitSource | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.admitSourceShort description From where patient was admitted (physician referral, transfer) DefinitionFrom where patient was admitted (physician referral, transfer). 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 source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. NHS Data Model and Dictionary Source Of Admission (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
reAdmission | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmissionShort description The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission DefinitionWhether this hospitalization is a readmission and why if known. 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 reason for re-admission of this hospitalization encounter. v2 Re-Admission Indicator (example) 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 idEncounter.hospitalization.reAdmission.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 idEncounter.hospitalization.reAdmission.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 idEncounter.hospitalization.reAdmission.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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
snomedCT | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission.coding:snomedCTShort 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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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
| ||
snomedCTDescriptionID | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionIDShort 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid ConditionsThe 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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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
http://snomed.info/sctMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.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
| ||
dietPreference | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.dietPreferenceShort description Diet preferences reported by the patient DefinitionDiet preferences reported by the patient. Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter. For example a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive). Medical, cultural or ethical food preferences to help with catering requirements. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
specialCourtesy | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialCourtesyShort description Special courtesies (VIP, board member) DefinitionSpecial courtesies (VIP, board member). 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. Special courtesies ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
specialArrangement | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialArrangementShort description Wheelchair, translator, stretcher, etc. DefinitionAny special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things. 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. Special arrangements SpecialArrangements (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
destination | C | 0..1 | Reference(CareConnect-Location-1) | There are no (further) constraints on this element Element idEncounter.hospitalization.destinationShort description Location to which the patient is discharged DefinitionLocation to which the patient is discharged. 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-Location-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
dischargeDisposition | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.dischargeDispositionShort description Category or kind of location after discharge DefinitionCategory or kind of location after discharge. 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 destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. NHS Data Model and Dictionary Discharge Destination (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
location | S | 1..1 | BackboneElement | Element idEncounter.locationShort description Ward the Patient is located DefinitionList of locations where the patient has been during this encounter. Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". 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 idEncounter.location.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 idEncounter.location.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 idEncounter.location.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
| ||
location | C | 1..1 | Reference(CareConnect-SHD-Location-1) | Element idEncounter.location.locationShort description Location the encounter takes place DefinitionThe location where the encounter takes place. 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-SHD-Location-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | 0..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.location.statusShort description planned | active | reserved | completed DefinitionThe status of the participants' presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time. When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed. The status of the location. EncounterLocationStatus (required) ConditionsThe 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 idEncounter.location.periodShort description Time period during which the patient was present at the location DefinitionTime period during which the patient was present at the location. 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
| ||
serviceProvider | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idEncounter.serviceProviderShort description The custodian organization of this Encounter record DefinitionAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization. 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 Constraints
| ||
partOf | C | 0..1 | Reference(CareConnect-Encounter-1) | There are no (further) constraints on this element Element idEncounter.partOfShort description Another Encounter this encounter is part of DefinitionAnother Encounter of which this encounter is a part of (administratively or in time). This is also used for associating a child's encounter back to the mother's encounter. Refer to the Notes section in the Patient resource for further details. Reference(CareConnect-Encounter-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Snapshot (default)
CareConnect-SHD-Encounter-1 (Encounter) | C | CareConnect-Encounter-1 | There are no (further) constraints on this element Element idEncounterShort description An interaction during which services are provided to the patient Alternate namesVisit DefinitionAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idEncounter.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 idEncounter.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
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEncounter.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 idEncounter.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 idEncounter.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
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idEncounter.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 | Element idEncounter.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
| ||
encounterTransport | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idEncounter.extension:encounterTransportShort 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EncounterTransport-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
outcomeOfAttendance | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.extension:outcomeOfAttendanceShort 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-OutcomeOfAttendance-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
emergencyCareDischargeStatus | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.extension:emergencyCareDischargeStatusShort 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
medicallyFitForDischarge | S C | 1..1 | Extension(Complex) | Element idEncounter.extension:medicallyFitForDischargeShort description Medically Fit for Discharge Alternate namesextensions, user content DefinitionWhether the patient is fit for discharge, i.e. all health/medical activities required fro a safe discharge have been completed 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.nottinghamshire.gov.uk/STU3/StructureDefinition/Extension-SHD-MedicallyFitDetails 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 idEncounter.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 | S Σ | 1..1 | Identifier | Element idEncounter.identifierShort description Identifier(s) by which this encounter is known DefinitionIdentifier(s) by which this encounter is known. The consumer (e.g. Hospital) must provide a unique identifier for encounter - the same identifier willl also need to be referenced when sharing any updates (e.g. chnage to Predicted Discharge Date) 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 idEncounter.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 idEncounter.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 idEncounter.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 idEncounter.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
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idEncounter.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 | Σ | 1..1 | string | There are no (further) constraints on this element Element idEncounter.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 idEncounter.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
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idEncounter.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. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | S Σ ?! | 1..1 | codeBinding | Element idEncounter.statusShort description planned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +. in-progress = use for initial referral and when sharing updates of an exising case finished = use when communicating the patient has been discharged normally (i.e. to social care) cancelled = use when communicating the patient has died/self-discharged or the referral is no longer required Current state of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
statusHistory | S | 0..* | BackboneElement | Element idEncounter.statusHistoryShort description List of past encounter statuses DefinitionThe status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them. Encounter MUST have a statusHistory for the previous status if Encounter.status = 'cancelled' 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 idEncounter.statusHistory.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 | Element idEncounter.statusHistory.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
| ||
encounterStatusChangeReason | C | 1..1 | Extension(CodeableConcept) | Element idEncounter.statusHistory.extension:encounterStatusChangeReasonShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.statusHistory.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
| ||
status | 1..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.statusHistory.statusShort description planned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +. Note that FHIR strings may not exceed 1MB in size Current state of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
period | C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.statusHistory.periodShort description The time that the episode was in the specified status DefinitionThe time that the episode was in the specified status. 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
| ||
class | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.classShort description Classification of the encounter DefinitionClassification of the encounter. 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. Classification of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
classHistory | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.classHistoryShort description List of past encounter classes DefinitionThe class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient. 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 idEncounter.classHistory.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 idEncounter.classHistory.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 idEncounter.classHistory.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
| ||
class | 1..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.classHistory.classShort description Classification of the encounter DefinitionClassification of the encounter. 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. Classification of the encounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
period | C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.classHistory.periodShort description The time that the episode was in the specified class DefinitionThe time that the episode was in the specified class. 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
| ||
type | S Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.typeShort description Specific type of encounter DefinitionSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). Since there are many ways to further classify encounters, this element is 0..*. The type of encounter 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 idEncounter.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 idEncounter.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 | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idEncounter.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. Unordered, Open, 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 idEncounter.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.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 Mappings
| |||
system | Σ | 1..1 | uriFixed Value | Element idEncounter.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. https://fhir.nottinghamshire.gov.uk/encounter/typeMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.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.
| ||
code | Σ | 1..1 | codeFixed Value | Element idEncounter.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. supported-dischargeMappings
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.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.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idEncounter.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.
| ||
snomedCT | Σ | 0..0 | CodingBinding | There are no (further) constraints on this element Element idEncounter.type.coding:snomedCTShort 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. A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). Care Connect Encounter Type (extensible) 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 idEncounter.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
| ||
priority | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.priorityShort description Indicates the urgency of the encounter DefinitionIndicates the urgency of the encounter. 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. Indicates the urgency of the encounter. v3 Code System ActPriority (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
subject | Σ C | 0..1 | Reference(Group | CareConnect-Patient-1) | There are no (further) constraints on this element Element idEncounter.subjectShort description The patient ro group present at the encounter Alternate namespatient DefinitionThe patient ro group present at the encounter. While the encounter is always about the patient, the patient may not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked). Reference(Group | CareConnect-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
episodeOfCare | Σ C | 0..* | Reference(EpisodeOfCare) | There are no (further) constraints on this element Element idEncounter.episodeOfCareShort description Episode(s) of care that this encounter should be recorded against DefinitionWhere a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
incomingReferral | C | 0..* | Reference(ReferralRequest) | There are no (further) constraints on this element Element idEncounter.incomingReferralShort description The ReferralRequest that initiated this encounter DefinitionThe referral request this encounter satisfies (incoming referral). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
participant | S Σ | 0..1 | BackboneElement | Element idEncounter.participantShort description Lead Clinician DefinitionThe details of the person at the hospital who is leading the patient’s care. A reference to the Lead Clinician practitioner who accepts overall responsibility for the Patient's Encounter 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 idEncounter.participant.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 idEncounter.participant.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 idEncounter.participant.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
| ||
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.participant.typeShort description Role of participant in encounter DefinitionRole of participant in encounter. The participant type indicates how an individual partitipates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc. Role of participant in encounter ConditionsThe 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 idEncounter.participant.periodShort description Period of time during the encounter that the participant participated DefinitionThe period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period. 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
| ||
individual | Σ C | 1..1 | Reference(CareConnect-SHD-Practitioner-1) | Element idEncounter.participant.individualShort description Persons involved in the encounter other than the patient DefinitionPersons involved in the encounter other than the patient. 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-SHD-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
appointment | Σ C | 0..1 | Reference(Appointment) | There are no (further) constraints on this element Element idEncounter.appointmentShort description The appointment that scheduled this encounter DefinitionThe appointment that scheduled this encounter. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
period | S C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.periodShort description The start and end time of the encounter DefinitionThe start and end time of the encounter. If not (yet) known, the end of the Period may be omitted. 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 idEncounter.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.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 Mappings
| |||
start | Σ C | 1..1 | dateTime | Element idEncounter.period.startShort description Admission Date 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: per-1 Mappings
| ||
end | S Σ C | 0..1 | dateTime | Element idEncounter.period.endShort description Discharge Date (Planned/Actual) 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. If status = 'in-progress' this is the current Predicted Discharge Date (PDD). If status = 'cancelled' this is the last recorded Predicted Discharge Date (PDD). If status = 'finished' this is the Actual Discharge Date. The PDD SHOULD be shared if recorded on the source system, however as there will be occasions when it is not populated, period.end is NOT mandatory when status = 'in-progress' or 'cancelled'. The Actual Discharge Date MUST be shared when the Patient has been discharged, as such period.end IS mandatory when status = 'finished'. PDD may also be known as EDD or PDMS 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: per-1 Mappings
| ||
length | C | 0..1 | Duration | There are no (further) constraints on this element Element idEncounter.lengthShort description Quantity of time the encounter lasted (less time absent) DefinitionQuantity of time the encounter lasted. This excludes the time during leaves of absence. May differ from the time the Encounter.period lasted because of leave of absence. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reason | S Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.reasonShort description Reason the encounter takes place (code) Alternate namesIndication, Admission diagnosis DefinitionReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). Reason why the encounter takes place. Encounter Reason Codes (preferred) 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 idEncounter.reason.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 idEncounter.reason.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 idEncounter.reason.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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
snomedCT | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idEncounter.reason.coding:snomedCTShort 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 idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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
| ||
snomedCTDescriptionID | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idEncounter.reason.coding:snomedCT.extension:snomedCTDescriptionIDShort 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid ConditionsThe 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 idEncounter.reason.coding:snomedCT.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
http://snomed.info/sctMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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 idEncounter.reason.coding:snomedCT.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 | Σ | 1..1 | string | Element idEncounter.reason.textShort description Reason for Admission to Hospital DefinitionSummary of why the Patient was admitted to hospital. 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
| ||
diagnosis | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.diagnosisShort description The list of diagnosis relevant to this encounter DefinitionThe list of diagnosis relevant to this encounter. 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 idEncounter.diagnosis.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 idEncounter.diagnosis.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 idEncounter.diagnosis.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
| ||
condition | C | 1..1 | Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) | There are no (further) constraints on this element Element idEncounter.diagnosis.conditionShort description Reason the encounter takes place (resource) Alternate namesAdmission diagnosis, discharge diagnosis, indication DefinitionReason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). Reference(CareConnect-Procedure-1 | CareConnect-Condition-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
role | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.diagnosis.roleShort description Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) DefinitionRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …). 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 type of diagnosis this condition represents 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 idEncounter.diagnosis.rankShort description Ranking of the diagnosis (for each role type) DefinitionRanking of the diagnosis (for each role type). 32 bit number; for values larger than this, use decimal The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
account | C | 0..* | Reference(Account) | There are no (further) constraints on this element Element idEncounter.accountShort description The set of accounts that may be used for billing for this Encounter DefinitionThe set of accounts that may be used for billing for this Encounter. The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
hospitalization | 0..1 | BackboneElement | There are no (further) constraints on this element Element idEncounter.hospitalizationShort description Details about the admission to a healthcare service DefinitionDetails about the admission to a healthcare service. An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included. The duration recorded in the period of this encounter covers the entire scope of this hospitalization record. 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 idEncounter.hospitalization.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 idEncounter.hospitalization.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
| ||
admissionMethod | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.hospitalization.extension:admissionMethodShort 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AdmissionMethod-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
dischargeMethod | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idEncounter.hospitalization.extension:dischargeMethodShort 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. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DischargeMethod-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 idEncounter.hospitalization.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
| ||
preAdmissionIdentifier | 0..1 | Identifier | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifierShort description Pre-admission identifier DefinitionPre-admission identifier. 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 idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier.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 | Σ | 1..1 | string | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier.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 idEncounter.hospitalization.preAdmissionIdentifier.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
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier.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
| ||
origin | C | 0..1 | Reference(CareConnect-Location-1) | There are no (further) constraints on this element Element idEncounter.hospitalization.originShort description The location from which the patient came before admission DefinitionThe location from which the patient came before admission. 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-Location-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
admitSource | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.admitSourceShort description From where patient was admitted (physician referral, transfer) DefinitionFrom where patient was admitted (physician referral, transfer). 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 source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. NHS Data Model and Dictionary Source Of Admission (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
reAdmission | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmissionShort description The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission DefinitionWhether this hospitalization is a readmission and why if known. 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 reason for re-admission of this hospitalization encounter. v2 Re-Admission Indicator (example) 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 idEncounter.hospitalization.reAdmission.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 idEncounter.hospitalization.reAdmission.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 idEncounter.hospitalization.reAdmission.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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
snomedCT | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission.coding:snomedCTShort 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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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
| ||
snomedCTDescriptionID | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionIDShort 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid ConditionsThe 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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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
http://snomed.info/sctMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.coding:snomedCT.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 idEncounter.hospitalization.reAdmission.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
| ||
dietPreference | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.dietPreferenceShort description Diet preferences reported by the patient DefinitionDiet preferences reported by the patient. Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter. For example a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive). Medical, cultural or ethical food preferences to help with catering requirements. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
specialCourtesy | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialCourtesyShort description Special courtesies (VIP, board member) DefinitionSpecial courtesies (VIP, board member). 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. Special courtesies ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
specialArrangement | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialArrangementShort description Wheelchair, translator, stretcher, etc. DefinitionAny special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things. 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. Special arrangements SpecialArrangements (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
destination | C | 0..1 | Reference(CareConnect-Location-1) | There are no (further) constraints on this element Element idEncounter.hospitalization.destinationShort description Location to which the patient is discharged DefinitionLocation to which the patient is discharged. 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-Location-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
dischargeDisposition | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.dischargeDispositionShort description Category or kind of location after discharge DefinitionCategory or kind of location after discharge. 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 destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. NHS Data Model and Dictionary Discharge Destination (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
location | S | 1..1 | BackboneElement | Element idEncounter.locationShort description Ward the Patient is located DefinitionList of locations where the patient has been during this encounter. Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". 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 idEncounter.location.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 idEncounter.location.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 idEncounter.location.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
| ||
location | C | 1..1 | Reference(CareConnect-SHD-Location-1) | Element idEncounter.location.locationShort description Location the encounter takes place DefinitionThe location where the encounter takes place. 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-SHD-Location-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | 0..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.location.statusShort description planned | active | reserved | completed DefinitionThe status of the participants' presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time. When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed. The status of the location. EncounterLocationStatus (required) ConditionsThe 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 idEncounter.location.periodShort description Time period during which the patient was present at the location DefinitionTime period during which the patient was present at the location. 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
| ||
serviceProvider | C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idEncounter.serviceProviderShort description The custodian organization of this Encounter record DefinitionAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization. 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 Constraints
| ||
partOf | C | 0..1 | Reference(CareConnect-Encounter-1) | There are no (further) constraints on this element Element idEncounter.partOfShort description Another Encounter this encounter is part of DefinitionAnother Encounter of which this encounter is a part of (administratively or in time). This is also used for associating a child's encounter back to the mother's encounter. Refer to the Notes section in the Patient resource for further details. Reference(CareConnect-Encounter-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Encounter Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-SHD-Encounter-1 profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
Encounter.extension |
1..1 | Extension-SHD-MedicallyFitDetails | Extension to share whether the patient is safe for discharge, i.e. no longer meeting ony of the clinical criteria to reside in hospital. |
Encounter.extension |
1..1 | Coding | Binding Supported Hospital Discharge Medically Fit Status |
Encounter.extension |
0..1 | DateTime | Constraint The dateDeemedMedicallyFit SHALL be provided when medicallyFitStatus="Medically Fit". |
Encounter.identifier | 1..1 | identifier | Constraint: the Encounter SHALL have an identifier where:Encounter.identifier.system={Local Trust System}Encounter.identifier.value={Unique Local ID Number} |
Encounter.status | 1..1 | code | Binding EncounterStatus See use case guidance for any specific business context constriants. |
Encounter.statusHistory | 0..* | BackboneElement | See use case guidance for any specific business context constriants. |
Encounter.type | 1..1 | CodeableConcept | SHALL have one type with single coding where: coding.system = 'https |
Encounter.participant | 0..1 | Reference (CareConnect-SHD-Practitioner-1) | Optional data element to share details of the person at the hospital who is leading the patient’s care. |
Encounter.participant.individual | 1..1 | Reference (CareConnect-SHD-Practitioner-1) | The encounter SHALL have a Encounter.participant.individual for the Lead Clincian if there is a Encounter.participant |
Encounter.period.start | 1..1 | DateTime | The actual hospital admission date for the patient. |
Encounter.period.end | 0..1 | DateTime | See use case guidance for any specific business context constriants. |
Encounter.reason.text | 1..1 | string | The reason(s) why the patient has been admitted to hospital. |
Encounter.location.location | 1..1 | Reference (CareConnect-SHD-Location-1) | Details of the current location (i.e. Ward/Hospital) of the Patient. |
CareConnect-SHD-Location-1
This is the StructureDefinition overview for the CareConnect-SHD-Location-1
The official URL for this profile is: https
Differential
CareConnect-SHD-Location-1 (Location) | C | CareConnect-Location-1 | There are no (further) constraints on this element Element idLocationShort description Details and position information for a physical place DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idLocation.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 idLocation.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
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLocation.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 idLocation.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 idLocation.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
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.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 idLocation.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
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idLocation.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 | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idLocation.identifierShort description Unique code or number identifying the location to its users DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. 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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idLocation.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 idLocation.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 idLocation.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
| ||
assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idLocation.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
| ||
odsSiteCode | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idLocation.identifier:odsSiteCodeShort description ODS Site code to identify the organisation at site level DefinitionODS Site code to identify the organisation at site level. Organization label locations in registries, need to keep track of those. 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 idLocation.identifier:odsSiteCode.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 idLocation.identifier:odsSiteCode.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 idLocation.identifier:odsSiteCode.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 idLocation.identifier:odsSiteCode.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
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idLocation.identifier:odsSiteCode.systemShort description ODS Code 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/ods-site-codeExamples 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 idLocation.identifier:odsSiteCode.valueShort description The ODS Site code name, to reflect the code used 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 idLocation.identifier:odsSiteCode.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
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idLocation.identifier:odsSiteCode.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
| ||
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.statusShort description active | suspended | inactive DefinitionThe status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Indicates whether the location is still in use. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatusShort description The Operational status of the location (typically only for a bed/room) DefinitionThe Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance. 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. The operational status if the location (where typically a bed/room) 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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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
| ||
name | S Σ | 1..1 | string | There are no (further) constraints on this element Element idLocation.nameShort description Name of the location as used by humans DefinitionName of the location as used by humans. Does not need to be unique. If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
alias | 0..* | string | There are no (further) constraints on this element Element idLocation.aliasShort description A list of alternate names that the location is known as, or was known as in the past DefinitionA list of alternate names that the location is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.descriptionShort description Additional details about the location that could be displayed as further information to identify the location beyond its name DefinitionDescription of the Location, which helps in finding or referencing the place. Humans need additional information to verify a correct location has been identified. 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
| ||
mode | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.modeShort description instance | kind DefinitionIndicates whether a resource instance represents a specific location or a class of locations. When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location. This is labeled as a modifer because whether or not the location is a class of locations changes how it can be used and understood. Indicates whether a resource instance represents a specific location or a class of locations. 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 idLocation.typeShort description Type of function performed DefinitionIndicates the type of function performed at the location. 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. Indicates the type of function performed at the location. ServiceDeliveryLocationRoleType (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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idLocation.telecomShort description Contact details of the location DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. 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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.addressShort description Physical location DefinitionPhysical location. If locations can be visited, we need to keep track of their address. This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types. 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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 9132Mappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idLocation.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 StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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 ErewhonMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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 MadisonMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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 idLocation.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 9132Mappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
physicalType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idLocation.physicalTypeShort description Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. 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. Physical form of the location 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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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
| ||
position | 0..1 | BackboneElement | There are no (further) constraints on this element Element idLocation.positionShort description The absolute geographic location DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). For mobile applications and automated route-finding knowing the exact location of the Location is required. 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 idLocation.position.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 idLocation.position.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 idLocation.position.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
| ||
longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitudeShort description Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitudeShort description Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitudeShort description Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
managingOrganization | S Σ C | 1..1 | Reference(CareConnect-SHD-Organization-1) | Element idLocation.managingOrganizationShort description Organization responsible for provisioning and upkeep DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource. Reference(CareConnect-SHD-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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
partOf | C | 0..1 | Reference(CareConnect-Location-1) | There are no (further) constraints on this element Element idLocation.partOfShort description Another Location this one is physically part of DefinitionAnother Location which this Location is physically part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. 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-Location-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 idLocation.partOf.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 idLocation.partOf.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 idLocation.partOf.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 idLocation.partOf.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 idLocation.partOf.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
| ||
endpoint | C | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idLocation.endpointShort description Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. 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. 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 idLocation.endpoint.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 idLocation.endpoint.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 idLocation.endpoint.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 idLocation.endpoint.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 idLocation.endpoint.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
|
Hybrid
CareConnect-SHD-Location-1 (Location) | C | CareConnect-Location-1 | There are no (further) constraints on this element Element idLocationShort description Details and position information for a physical place DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idLocation.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 idLocation.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
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLocation.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 idLocation.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 idLocation.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
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.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 idLocation.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
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idLocation.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 | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idLocation.identifierShort description Unique code or number identifying the location to its users DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. 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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idLocation.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 idLocation.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 idLocation.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
| ||
assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idLocation.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
| ||
odsSiteCode | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idLocation.identifier:odsSiteCodeShort description ODS Site code to identify the organisation at site level DefinitionODS Site code to identify the organisation at site level. Organization label locations in registries, need to keep track of those. 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 idLocation.identifier:odsSiteCode.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 idLocation.identifier:odsSiteCode.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 idLocation.identifier:odsSiteCode.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 idLocation.identifier:odsSiteCode.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
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idLocation.identifier:odsSiteCode.systemShort description ODS Code 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/ods-site-codeExamples 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 idLocation.identifier:odsSiteCode.valueShort description The ODS Site code name, to reflect the code used 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 idLocation.identifier:odsSiteCode.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
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idLocation.identifier:odsSiteCode.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
| ||
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.statusShort description active | suspended | inactive DefinitionThe status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Indicates whether the location is still in use. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatusShort description The Operational status of the location (typically only for a bed/room) DefinitionThe Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance. 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. The operational status if the location (where typically a bed/room) 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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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
| ||
name | S Σ | 1..1 | string | There are no (further) constraints on this element Element idLocation.nameShort description Name of the location as used by humans DefinitionName of the location as used by humans. Does not need to be unique. If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
alias | 0..* | string | There are no (further) constraints on this element Element idLocation.aliasShort description A list of alternate names that the location is known as, or was known as in the past DefinitionA list of alternate names that the location is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.descriptionShort description Additional details about the location that could be displayed as further information to identify the location beyond its name DefinitionDescription of the Location, which helps in finding or referencing the place. Humans need additional information to verify a correct location has been identified. 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
| ||
mode | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.modeShort description instance | kind DefinitionIndicates whether a resource instance represents a specific location or a class of locations. When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location. This is labeled as a modifer because whether or not the location is a class of locations changes how it can be used and understood. Indicates whether a resource instance represents a specific location or a class of locations. 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 idLocation.typeShort description Type of function performed DefinitionIndicates the type of function performed at the location. 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. Indicates the type of function performed at the location. ServiceDeliveryLocationRoleType (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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idLocation.telecomShort description Contact details of the location DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. 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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.addressShort description Physical location DefinitionPhysical location. If locations can be visited, we need to keep track of their address. This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types. 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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 9132Mappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idLocation.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 StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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 ErewhonMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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 MadisonMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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 idLocation.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 9132Mappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
physicalType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idLocation.physicalTypeShort description Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. 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. Physical form of the location 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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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
| ||
position | 0..1 | BackboneElement | There are no (further) constraints on this element Element idLocation.positionShort description The absolute geographic location DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). For mobile applications and automated route-finding knowing the exact location of the Location is required. 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 idLocation.position.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 idLocation.position.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 idLocation.position.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
| ||
longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitudeShort description Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitudeShort description Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitudeShort description Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
managingOrganization | S Σ C | 1..1 | Reference(CareConnect-SHD-Organization-1) | Element idLocation.managingOrganizationShort description Organization responsible for provisioning and upkeep DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource. Reference(CareConnect-SHD-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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
partOf | C | 0..1 | Reference(CareConnect-Location-1) | There are no (further) constraints on this element Element idLocation.partOfShort description Another Location this one is physically part of DefinitionAnother Location which this Location is physically part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. 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-Location-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 idLocation.partOf.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 idLocation.partOf.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 idLocation.partOf.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 idLocation.partOf.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 idLocation.partOf.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
| ||
endpoint | C | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idLocation.endpointShort description Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. 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. 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 idLocation.endpoint.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 idLocation.endpoint.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 idLocation.endpoint.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 idLocation.endpoint.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 idLocation.endpoint.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
|
Snapshot (default)
CareConnect-SHD-Location-1 (Location) | C | CareConnect-Location-1 | There are no (further) constraints on this element Element idLocationShort description Details and position information for a physical place DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idLocation.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 idLocation.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
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLocation.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 idLocation.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 idLocation.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
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.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 idLocation.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
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idLocation.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 | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idLocation.identifierShort description Unique code or number identifying the location to its users DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. 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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idLocation.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 idLocation.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 idLocation.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
| ||
assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idLocation.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
| ||
odsSiteCode | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idLocation.identifier:odsSiteCodeShort description ODS Site code to identify the organisation at site level DefinitionODS Site code to identify the organisation at site level. Organization label locations in registries, need to keep track of those. 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 idLocation.identifier:odsSiteCode.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 idLocation.identifier:odsSiteCode.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 idLocation.identifier:odsSiteCode.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 idLocation.identifier:odsSiteCode.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
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idLocation.identifier:odsSiteCode.systemShort description ODS Code 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/ods-site-codeExamples 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 idLocation.identifier:odsSiteCode.valueShort description The ODS Site code name, to reflect the code used 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 idLocation.identifier:odsSiteCode.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
| ||
assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idLocation.identifier:odsSiteCode.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
| ||
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.statusShort description active | suspended | inactive DefinitionThe status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Indicates whether the location is still in use. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatusShort description The Operational status of the location (typically only for a bed/room) DefinitionThe Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance. 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. The operational status if the location (where typically a bed/room) 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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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 idLocation.operationalStatus.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
| ||
name | S Σ | 1..1 | string | There are no (further) constraints on this element Element idLocation.nameShort description Name of the location as used by humans DefinitionName of the location as used by humans. Does not need to be unique. If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
alias | 0..* | string | There are no (further) constraints on this element Element idLocation.aliasShort description A list of alternate names that the location is known as, or was known as in the past DefinitionA list of alternate names that the location is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.descriptionShort description Additional details about the location that could be displayed as further information to identify the location beyond its name DefinitionDescription of the Location, which helps in finding or referencing the place. Humans need additional information to verify a correct location has been identified. 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
| ||
mode | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.modeShort description instance | kind DefinitionIndicates whether a resource instance represents a specific location or a class of locations. When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location. This is labeled as a modifer because whether or not the location is a class of locations changes how it can be used and understood. Indicates whether a resource instance represents a specific location or a class of locations. 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 idLocation.typeShort description Type of function performed DefinitionIndicates the type of function performed at the location. 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. Indicates the type of function performed at the location. ServiceDeliveryLocationRoleType (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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idLocation.telecomShort description Contact details of the location DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. 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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.addressShort description Physical location DefinitionPhysical location. If locations can be visited, we need to keep track of their address. This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types. 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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 9132Mappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idLocation.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 StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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 ErewhonMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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 MadisonMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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 idLocation.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 9132Mappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.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
| ||
period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
physicalType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idLocation.physicalTypeShort description Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. 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. Physical form of the location 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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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 idLocation.physicalType.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
| ||
position | 0..1 | BackboneElement | There are no (further) constraints on this element Element idLocation.positionShort description The absolute geographic location DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). For mobile applications and automated route-finding knowing the exact location of the Location is required. 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 idLocation.position.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 idLocation.position.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 idLocation.position.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
| ||
longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitudeShort description Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitudeShort description Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitudeShort description Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
managingOrganization | S Σ C | 1..1 | Reference(CareConnect-SHD-Organization-1) | Element idLocation.managingOrganizationShort description Organization responsible for provisioning and upkeep DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource. Reference(CareConnect-SHD-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 idLocation.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 idLocation.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 idLocation.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 idLocation.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 idLocation.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
| ||
partOf | C | 0..1 | Reference(CareConnect-Location-1) | There are no (further) constraints on this element Element idLocation.partOfShort description Another Location this one is physically part of DefinitionAnother Location which this Location is physically part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. 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-Location-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 idLocation.partOf.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 idLocation.partOf.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 idLocation.partOf.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 idLocation.partOf.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 idLocation.partOf.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
| ||
endpoint | C | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idLocation.endpointShort description Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. 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. 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 idLocation.endpoint.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 idLocation.endpoint.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 idLocation.endpoint.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 idLocation.endpoint.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 idLocation.endpoint.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
|
Location Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-SHD-Location-1 profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
Location.name | 1..1 | string | Plain text representation of the ward/department the patient is currently located. If the ward/department is not recorded use 'unknown' or similar descriptor. |
Location.managingOrganization | 1..1 | Reference (CareConnect-SHD-Organization-1) | Reference to an Organization resource for the Hospital the patient is currently in. |
CareConnect-SHD-Organization-1
This is the StructureDefinition overview for the CareConnect-SHD-Organization-1
The official URL for this profile is: https
Differential
CareConnect-SHD-Organization-1 (Organization) | C | CareConnect-Organization-1 | There are no (further) constraints on this element Element idOrganizationShort description A grouping of people or organizations with a common purpose DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idOrganization.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. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.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. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.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. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.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
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.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: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.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 | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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) Mappings
| |||
mainLocation | C | 0..1 | Extension(Reference(CareConnect-Location-1)) | There are no (further) constraints on this element Element idOrganization.extension:mainLocationShort description Main location Alternate namesextensions, user content DefinitionThe main location of the organization. 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-Location-1)) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
organization-period | C | 0..1 | Extension(Period) | There are no (further) constraints on this element Element idOrganization.extension:organization-periodShort description The date range that this organization should be considered available Alternate namesextensions, user content DefinitionThe date range that this organization should be considered available. 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/organization-period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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.
| ||
identifier | Σ C | 0..* | Identifier | There are no (further) constraints on this element Element idOrganization.identifierShort description Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open At End, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
odsOrganisationCode | Σ C | 0..1 | Identifier | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCodeShort description Organisation Data Service code DefinitionIdentifier code supplier by the Organisation Data Service Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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 idOrganization.identifier:odsOrganisationCode.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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. https://fhir.nhs.uk/Id/ods-organization-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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) Mappings
| ||
odsSiteCode | S Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCodeShort description ODS Site code to identify the organisation at site level DefinitionODS Site code to identify the organisation at site level Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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 idOrganization.identifier:odsSiteCode.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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. https://fhir.nhs.uk/Id/ods-site-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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) Mappings
| ||
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.activeShort description Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. Default is true. This active flag is not intended to be used to mark an organizations as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. trueMappings
| ||
type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idOrganization.typeShort description Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. Used to categorize the organization Mappings
| ||
name | S Σ C | 1..1 | string | There are no (further) constraints on this element Element idOrganization.nameShort description Name used for the organization DefinitionA name associated with the organization. Need to use the name as the label of the organization. If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. The cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.aliasShort description A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
| |||
telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecomShort description A contact detail for the organization DefinitionA contact detail for the organization. Human contact for the organization. The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. The cardinality or value of this element may be affected by these constraints: org-3 Constraints
| ||
address | C | 0..* | Address | There are no (further) constraints on this element Element idOrganization.addressShort description An address for the organization DefinitionAn address for the organization. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used. The cardinality or value of this element may be affected by these constraints: org-2 Constraints
| ||
partOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idOrganization.partOfShort description The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. Reference(CareConnect-Organization-1) Mappings
| ||
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contactShort description Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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.
| ||
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purposeShort description The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. The purpose for which you would contact a contact party ContactEntityType (extensible) Mappings
| |||
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.nameShort description A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.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 Mappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
family | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.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.
| ||
telecom | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecomShort description Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
| |||
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.addressShort description Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements.
| |||
endpoint | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpointShort description Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
|
Hybrid
CareConnect-SHD-Organization-1 (Organization) | C | CareConnect-Organization-1 | There are no (further) constraints on this element Element idOrganizationShort description A grouping of people or organizations with a common purpose DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idOrganization.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. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.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. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.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. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.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
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.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: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.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 | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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) Mappings
| |||
mainLocation | C | 0..1 | Extension(Reference(CareConnect-Location-1)) | There are no (further) constraints on this element Element idOrganization.extension:mainLocationShort description Main location Alternate namesextensions, user content DefinitionThe main location of the organization. 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-Location-1)) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
organization-period | C | 0..1 | Extension(Period) | There are no (further) constraints on this element Element idOrganization.extension:organization-periodShort description The date range that this organization should be considered available Alternate namesextensions, user content DefinitionThe date range that this organization should be considered available. 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/organization-period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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.
| ||
identifier | Σ C | 0..* | Identifier | There are no (further) constraints on this element Element idOrganization.identifierShort description Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open At End, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
odsOrganisationCode | Σ C | 0..1 | Identifier | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCodeShort description Organisation Data Service code DefinitionIdentifier code supplier by the Organisation Data Service Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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 idOrganization.identifier:odsOrganisationCode.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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. https://fhir.nhs.uk/Id/ods-organization-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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) Mappings
| ||
odsSiteCode | S Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCodeShort description ODS Site code to identify the organisation at site level DefinitionODS Site code to identify the organisation at site level Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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 idOrganization.identifier:odsSiteCode.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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. https://fhir.nhs.uk/Id/ods-site-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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) Mappings
| ||
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.activeShort description Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. Default is true. This active flag is not intended to be used to mark an organizations as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. trueMappings
| ||
type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idOrganization.typeShort description Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. Used to categorize the organization Mappings
| ||
name | S Σ C | 1..1 | string | There are no (further) constraints on this element Element idOrganization.nameShort description Name used for the organization DefinitionA name associated with the organization. Need to use the name as the label of the organization. If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. The cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.aliasShort description A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
| |||
telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecomShort description A contact detail for the organization DefinitionA contact detail for the organization. Human contact for the organization. The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. The cardinality or value of this element may be affected by these constraints: org-3 Constraints
| ||
address | C | 0..* | Address | There are no (further) constraints on this element Element idOrganization.addressShort description An address for the organization DefinitionAn address for the organization. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used. The cardinality or value of this element may be affected by these constraints: org-2 Constraints
| ||
partOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idOrganization.partOfShort description The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. Reference(CareConnect-Organization-1) Mappings
| ||
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contactShort description Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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.
| ||
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purposeShort description The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. The purpose for which you would contact a contact party ContactEntityType (extensible) Mappings
| |||
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.nameShort description A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.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 Mappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
family | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.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.
| ||
telecom | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecomShort description Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
| |||
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.addressShort description Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements.
| |||
endpoint | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpointShort description Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
|
Snapshot (default)
CareConnect-SHD-Organization-1 (Organization) | C | CareConnect-Organization-1 | There are no (further) constraints on this element Element idOrganizationShort description A grouping of people or organizations with a common purpose DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idOrganization.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. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.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. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.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. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.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
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.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: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.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 | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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) Mappings
| |||
mainLocation | C | 0..1 | Extension(Reference(CareConnect-Location-1)) | There are no (further) constraints on this element Element idOrganization.extension:mainLocationShort description Main location Alternate namesextensions, user content DefinitionThe main location of the organization. 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-Location-1)) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
organization-period | C | 0..1 | Extension(Period) | There are no (further) constraints on this element Element idOrganization.extension:organization-periodShort description The date range that this organization should be considered available Alternate namesextensions, user content DefinitionThe date range that this organization should be considered available. 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/organization-period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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.
| ||
identifier | Σ C | 0..* | Identifier | There are no (further) constraints on this element Element idOrganization.identifierShort description Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open At End, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
odsOrganisationCode | Σ C | 0..1 | Identifier | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCodeShort description Organisation Data Service code DefinitionIdentifier code supplier by the Organisation Data Service Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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 idOrganization.identifier:odsOrganisationCode.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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. https://fhir.nhs.uk/Id/ods-organization-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.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) Mappings
| ||
odsSiteCode | S Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCodeShort description ODS Site code to identify the organisation at site level DefinitionODS Site code to identify the organisation at site level Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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 idOrganization.identifier:odsSiteCode.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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. https://fhir.nhs.uk/Id/ods-site-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.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) Mappings
| ||
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.activeShort description Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. Default is true. This active flag is not intended to be used to mark an organizations as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. trueMappings
| ||
type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idOrganization.typeShort description Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. Used to categorize the organization Mappings
| ||
name | S Σ C | 1..1 | string | There are no (further) constraints on this element Element idOrganization.nameShort description Name used for the organization DefinitionA name associated with the organization. Need to use the name as the label of the organization. If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. The cardinality or value of this element may be affected by these constraints: org-1 Mappings
| ||
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.aliasShort description A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
| |||
telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecomShort description A contact detail for the organization DefinitionA contact detail for the organization. Human contact for the organization. The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. The cardinality or value of this element may be affected by these constraints: org-3 Constraints
| ||
address | C | 0..* | Address | There are no (further) constraints on this element Element idOrganization.addressShort description An address for the organization DefinitionAn address for the organization. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used. The cardinality or value of this element may be affected by these constraints: org-2 Constraints
| ||
partOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idOrganization.partOfShort description The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. Reference(CareConnect-Organization-1) Mappings
| ||
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contactShort description Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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.
| ||
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purposeShort description The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. The purpose for which you would contact a contact party ContactEntityType (extensible) Mappings
| |||
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.nameShort description A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.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 Mappings
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
family | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.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.
| ||
telecom | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecomShort description Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
| |||
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.addressShort description Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements.
| |||
endpoint | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpointShort description Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
|
Organization Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-SHD-Organization-1 profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
Organization.identifier | 0..* | identifier | Constraint: Multiple identifiers may be provided, however one SHALL be the odsSiteCode |
Organization.identifier[odsSiteCode] | 1..1 | identifier | Constraint: Organization.identifier.system = 'https |
Organization.name | 1..1 | string | Plain text representation of the hospital name. |
CareConnect-SHD-Practitioner-1
This is the StructureDefinition overview for the CareConnect-SHD-Practitioner-1
The official URL for this profile is: https
Differential
CareConnect-SHD-Practitioner-1 (Practitioner) | C | CareConnect-Practitioner-1 | There are no (further) constraints on this element Element idPractitionerShort description A person with a formal responsibility in the provisioning of healthcare or related services DefinitionA person who is directly or indirectly involved in the provisioning of healthcare. Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idPractitioner.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. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPractitioner.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. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitioner.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. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.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
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idPractitioner.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: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idPractitioner.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 | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.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) Mappings
| |||
nhsCommunication | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idPractitioner.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
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.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 | Element idPractitioner.extension:nhsCommunication.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
| ||
language | C | 1..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:languageShort description Languages which may be used for communication Alternate namesextensions, user content DefinitionLanguages 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. 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 idPractitioner.extension:nhsCommunication.extension:language.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 idPractitioner.extension:nhsCommunication.extension:language.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 idPractitioner.extension:nhsCommunication.extension:language.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
languageMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:language.value[x]:valueCodeableConceptShort description Languages which may be used for communication DefinitionLanguages which may be used for communication. A stream of bytes, base64 encoded Human Language Care Connect Human Language (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
preferred | C | 0..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:preferredShort description Language preference indicator 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. 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 idPractitioner.extension:nhsCommunication.extension:preferred.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 idPractitioner.extension:nhsCommunication.extension:preferred.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 idPractitioner.extension:nhsCommunication.extension:preferred.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
preferredMappings
| |||
valueBoolean | 1..1 | boolean | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:preferred.valueBoolean:valueBooleanShort description Indicates whether or not this language is preferred (over other languages up a certain level) DefinitionIndicates whether or not this language is preferred (over other languages up a certain level) A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
modeOfCommunication | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:modeOfCommunicationShort description Mode of communication for the selected language 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. 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 idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.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 idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.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 idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.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
modeOfCommunicationMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConceptShort description A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. DefinitionA valueset to describe the mode the patient can communicate in, representing the method of expression of the language.. A stream of bytes, base64 encoded Language Ability Mode Care Connect Language Ability Mode (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
communicationProficiency | C | 0..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:communicationProficiencyShort description The level of proficiency in communicating a language 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. 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 idPractitioner.extension:nhsCommunication.extension:communicationProficiency.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 idPractitioner.extension:nhsCommunication.extension:communicationProficiency.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 idPractitioner.extension:nhsCommunication.extension:communicationProficiency.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
communicationProficiencyMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConceptShort description A valueset to describe the level of proficiency in communicating a language DefinitionA valueset to describe the level of proficiency in communicating a language. A stream of bytes, base64 encoded Language Ability Proficiency Care Connect Language Ability Proficiency (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
interpreterRequired | C | 0..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:interpreterRequiredShort description Interpreter preference indicator 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. 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 idPractitioner.extension:nhsCommunication.extension:interpreterRequired.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 idPractitioner.extension:nhsCommunication.extension:interpreterRequired.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 idPractitioner.extension:nhsCommunication.extension:interpreterRequired.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
interpreterRequiredMappings
| |||
valueBoolean | 1..1 | boolean | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:interpreterRequired.valueBoolean:valueBooleanShort description Indicates whether an interpreter is required for communication purposes DefinitionIndicates whether an interpreter is required for communication purposes- True / False? A stream of bytes, base64 encoded The 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 idPractitioner.extension:nhsCommunication.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-NHSCommunication-1Mappings
| |||
value[x] | 0..0 | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.value[x]Short description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.identifierShort description A identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent. Unordered, Open At End, by system(Value) Mappings
| ||
sdsUserID | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserIDShort description A identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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 idPractitioner.identifier:sdsUserID.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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. https://fhir.nhs.uk/Id/sds-user-idExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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) Mappings
| ||
sdsRoleProfileID | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileIDShort description A identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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 idPractitioner.identifier:sdsRoleProfileID.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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. https://fhir.nhs.uk/Id/sds-role-profile-idExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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) Mappings
| ||
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPractitioner.activeShort description Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. Default is true. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. trueMappings
| ||
name | S Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idPractitioner.nameShort description The name(s) associated with the practitioner DefinitionThe name(s) associated with the practitioner. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general select the value to be used in the ResourceReference.display based on this:
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.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 Mappings
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.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 Fixed valueofficialMappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.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.
| ||
telecom | Σ | 0..* | ContactPoint | Element idPractitioner.telecomShort description A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person 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 These typically will have home numbers, or mobile numbers that are not role specific. Unordered, Open, by system(Value), use(Value) Mappings
| ||
workPhone | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPractitioner.telecom:workPhoneShort description A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person 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 These typically will have home numbers, or mobile numbers that are not role specific.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.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 idPractitioner.telecom:workPhone.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workPhone.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed valuephoneMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workPhone.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 Fixed valueworkMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
workEmail | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPractitioner.telecom:workEmailShort description A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person 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 These typically will have home numbers, or mobile numbers that are not role specific.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.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 idPractitioner.telecom:workEmail.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workEmail.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed value
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workEmail.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 Fixed valueworkMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
address | Σ | 0..* | Address | Element idPractitioner.addressShort description Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Unordered, Open, by use(Value) Mappings
| ||
workAddress | S Σ | 0..1 | Address | There are no (further) constraints on this element Element idPractitioner.address:workAddressShort description Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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 idPractitioner.address:workAddress.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
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.address:workAddress.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 Fixed valueworkExamples General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General 137 Nowhere Street, Erewhon 9132Mappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General 137 Nowhere StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General MadisonMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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).
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132Mappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed to address the person correctly. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| ||
birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idPractitioner.birthDateShort description The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification.
| ||
photo | 0..* | Attachment | There are no (further) constraints on this element Element idPractitioner.photoShort description Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
| |||
qualification | S | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPractitioner.qualificationShort description Qualifications obtained by training and certification DefinitionQualifications obtained by training and certification.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.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 idPractitioner.qualification.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.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.
| ||
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.qualification.identifierShort description An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.qualification.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.qualification.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) Mappings
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPractitioner.qualification.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.qualification.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.qualification.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. Reference(CareConnect-Organization-1) Mappings
| ||
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idPractitioner.qualification.codeShort description Coded representation of the qualification DefinitionCoded representation of the qualification. Specific qualification the practitioner has to provide a service v2 table 0360, Version 2.7 (example) Mappings
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.code.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 idPractitioner.qualification.code.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPractitioner.qualification.code.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.
| ||
text | Σ | 1..1 | string | Element idPractitioner.qualification.code.textShort description Plain text representation of the concept DefinitionTextual representation of the Practitioner's Role/Job Title - e.g. Discharge Nurse 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.
| ||
period | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.qualification.periodShort description Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked.
| |||
issuer | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.qualification.issuerShort description Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. Reference(CareConnect-Organization-1) Mappings
| |||
communication | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.communicationShort description A language the practitioner is able to use in patient communication DefinitionA language the practitioner is able to use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language. Binding extensions
|
Hybrid
CareConnect-SHD-Practitioner-1 (Practitioner) | C | CareConnect-Practitioner-1 | There are no (further) constraints on this element Element idPractitionerShort description A person with a formal responsibility in the provisioning of healthcare or related services DefinitionA person who is directly or indirectly involved in the provisioning of healthcare. Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idPractitioner.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. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPractitioner.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. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitioner.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. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.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
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idPractitioner.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: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idPractitioner.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 | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.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) Mappings
| |||
nhsCommunication | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idPractitioner.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
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.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 | Element idPractitioner.extension:nhsCommunication.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
| ||
language | C | 1..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:languageShort description Languages which may be used for communication Alternate namesextensions, user content DefinitionLanguages 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. 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 idPractitioner.extension:nhsCommunication.extension:language.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 idPractitioner.extension:nhsCommunication.extension:language.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 idPractitioner.extension:nhsCommunication.extension:language.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
languageMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:language.value[x]:valueCodeableConceptShort description Languages which may be used for communication DefinitionLanguages which may be used for communication. A stream of bytes, base64 encoded Human Language Care Connect Human Language (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
preferred | C | 0..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:preferredShort description Language preference indicator 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. 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 idPractitioner.extension:nhsCommunication.extension:preferred.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 idPractitioner.extension:nhsCommunication.extension:preferred.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 idPractitioner.extension:nhsCommunication.extension:preferred.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
preferredMappings
| |||
valueBoolean | 1..1 | boolean | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:preferred.valueBoolean:valueBooleanShort description Indicates whether or not this language is preferred (over other languages up a certain level) DefinitionIndicates whether or not this language is preferred (over other languages up a certain level) A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
modeOfCommunication | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:modeOfCommunicationShort description Mode of communication for the selected language 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. 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 idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.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 idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.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 idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.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
modeOfCommunicationMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConceptShort description A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. DefinitionA valueset to describe the mode the patient can communicate in, representing the method of expression of the language.. A stream of bytes, base64 encoded Language Ability Mode Care Connect Language Ability Mode (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
communicationProficiency | C | 0..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:communicationProficiencyShort description The level of proficiency in communicating a language 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. 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 idPractitioner.extension:nhsCommunication.extension:communicationProficiency.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 idPractitioner.extension:nhsCommunication.extension:communicationProficiency.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 idPractitioner.extension:nhsCommunication.extension:communicationProficiency.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
communicationProficiencyMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConceptShort description A valueset to describe the level of proficiency in communicating a language DefinitionA valueset to describe the level of proficiency in communicating a language. A stream of bytes, base64 encoded Language Ability Proficiency Care Connect Language Ability Proficiency (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
interpreterRequired | C | 0..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:interpreterRequiredShort description Interpreter preference indicator 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. 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 idPractitioner.extension:nhsCommunication.extension:interpreterRequired.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 idPractitioner.extension:nhsCommunication.extension:interpreterRequired.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 idPractitioner.extension:nhsCommunication.extension:interpreterRequired.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
interpreterRequiredMappings
| |||
valueBoolean | 1..1 | boolean | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:interpreterRequired.valueBoolean:valueBooleanShort description Indicates whether an interpreter is required for communication purposes DefinitionIndicates whether an interpreter is required for communication purposes- True / False? A stream of bytes, base64 encoded The 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 idPractitioner.extension:nhsCommunication.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-NHSCommunication-1Mappings
| |||
value[x] | 0..0 | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.value[x]Short description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.identifierShort description A identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent. Unordered, Open At End, by system(Value) Mappings
| ||
sdsUserID | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserIDShort description A identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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 idPractitioner.identifier:sdsUserID.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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. https://fhir.nhs.uk/Id/sds-user-idExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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) Mappings
| ||
sdsRoleProfileID | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileIDShort description A identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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 idPractitioner.identifier:sdsRoleProfileID.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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. https://fhir.nhs.uk/Id/sds-role-profile-idExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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) Mappings
| ||
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPractitioner.activeShort description Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. Default is true. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. trueMappings
| ||
name | S Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idPractitioner.nameShort description The name(s) associated with the practitioner DefinitionThe name(s) associated with the practitioner. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general select the value to be used in the ResourceReference.display based on this:
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.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 Mappings
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.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 Fixed valueofficialMappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.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.
| ||
telecom | Σ | 0..* | ContactPoint | Element idPractitioner.telecomShort description A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person 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 These typically will have home numbers, or mobile numbers that are not role specific. Unordered, Open, by system(Value), use(Value) Mappings
| ||
workPhone | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPractitioner.telecom:workPhoneShort description A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person 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 These typically will have home numbers, or mobile numbers that are not role specific.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.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 idPractitioner.telecom:workPhone.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workPhone.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed valuephoneMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workPhone.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 Fixed valueworkMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
workEmail | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPractitioner.telecom:workEmailShort description A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person 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 These typically will have home numbers, or mobile numbers that are not role specific.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.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 idPractitioner.telecom:workEmail.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workEmail.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed value
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workEmail.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 Fixed valueworkMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
address | Σ | 0..* | Address | Element idPractitioner.addressShort description Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Unordered, Open, by use(Value) Mappings
| ||
workAddress | S Σ | 0..1 | Address | There are no (further) constraints on this element Element idPractitioner.address:workAddressShort description Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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 idPractitioner.address:workAddress.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
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.address:workAddress.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 Fixed valueworkExamples General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General 137 Nowhere Street, Erewhon 9132Mappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General 137 Nowhere StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General MadisonMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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).
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132Mappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed to address the person correctly. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| ||
birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idPractitioner.birthDateShort description The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification.
| ||
photo | 0..* | Attachment | There are no (further) constraints on this element Element idPractitioner.photoShort description Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
| |||
qualification | S | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPractitioner.qualificationShort description Qualifications obtained by training and certification DefinitionQualifications obtained by training and certification.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.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 idPractitioner.qualification.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.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.
| ||
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.qualification.identifierShort description An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.qualification.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.qualification.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) Mappings
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPractitioner.qualification.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.qualification.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.qualification.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. Reference(CareConnect-Organization-1) Mappings
| ||
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idPractitioner.qualification.codeShort description Coded representation of the qualification DefinitionCoded representation of the qualification. Specific qualification the practitioner has to provide a service v2 table 0360, Version 2.7 (example) Mappings
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.code.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 idPractitioner.qualification.code.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPractitioner.qualification.code.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.
| ||
text | Σ | 1..1 | string | Element idPractitioner.qualification.code.textShort description Plain text representation of the concept DefinitionTextual representation of the Practitioner's Role/Job Title - e.g. Discharge Nurse 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.
| ||
period | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.qualification.periodShort description Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked.
| |||
issuer | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.qualification.issuerShort description Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. Reference(CareConnect-Organization-1) Mappings
| |||
communication | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.communicationShort description A language the practitioner is able to use in patient communication DefinitionA language the practitioner is able to use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language. Binding extensions
|
Snapshot (default)
CareConnect-SHD-Practitioner-1 (Practitioner) | C | CareConnect-Practitioner-1 | There are no (further) constraints on this element Element idPractitionerShort description A person with a formal responsibility in the provisioning of healthcare or related services DefinitionA person who is directly or indirectly involved in the provisioning of healthcare. Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idPractitioner.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. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPractitioner.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. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitioner.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. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.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
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idPractitioner.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: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idPractitioner.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 | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.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) Mappings
| |||
nhsCommunication | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idPractitioner.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
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.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 | Element idPractitioner.extension:nhsCommunication.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
| ||
language | C | 1..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:languageShort description Languages which may be used for communication Alternate namesextensions, user content DefinitionLanguages 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. 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 idPractitioner.extension:nhsCommunication.extension:language.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 idPractitioner.extension:nhsCommunication.extension:language.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 idPractitioner.extension:nhsCommunication.extension:language.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
languageMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:language.value[x]:valueCodeableConceptShort description Languages which may be used for communication DefinitionLanguages which may be used for communication. A stream of bytes, base64 encoded Human Language Care Connect Human Language (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
preferred | C | 0..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:preferredShort description Language preference indicator 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. 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 idPractitioner.extension:nhsCommunication.extension:preferred.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 idPractitioner.extension:nhsCommunication.extension:preferred.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 idPractitioner.extension:nhsCommunication.extension:preferred.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
preferredMappings
| |||
valueBoolean | 1..1 | boolean | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:preferred.valueBoolean:valueBooleanShort description Indicates whether or not this language is preferred (over other languages up a certain level) DefinitionIndicates whether or not this language is preferred (over other languages up a certain level) A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
modeOfCommunication | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:modeOfCommunicationShort description Mode of communication for the selected language 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. 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 idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.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 idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.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 idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.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
modeOfCommunicationMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConceptShort description A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. DefinitionA valueset to describe the mode the patient can communicate in, representing the method of expression of the language.. A stream of bytes, base64 encoded Language Ability Mode Care Connect Language Ability Mode (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
communicationProficiency | C | 0..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:communicationProficiencyShort description The level of proficiency in communicating a language 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. 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 idPractitioner.extension:nhsCommunication.extension:communicationProficiency.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 idPractitioner.extension:nhsCommunication.extension:communicationProficiency.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 idPractitioner.extension:nhsCommunication.extension:communicationProficiency.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
communicationProficiencyMappings
| |||
valueCodeableConcept | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConceptShort description A valueset to describe the level of proficiency in communicating a language DefinitionA valueset to describe the level of proficiency in communicating a language. A stream of bytes, base64 encoded Language Ability Proficiency Care Connect Language Ability Proficiency (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
interpreterRequired | C | 0..1 | Extension | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:interpreterRequiredShort description Interpreter preference indicator 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. 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 idPractitioner.extension:nhsCommunication.extension:interpreterRequired.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 idPractitioner.extension:nhsCommunication.extension:interpreterRequired.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 idPractitioner.extension:nhsCommunication.extension:interpreterRequired.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
interpreterRequiredMappings
| |||
valueBoolean | 1..1 | boolean | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.extension:interpreterRequired.valueBoolean:valueBooleanShort description Indicates whether an interpreter is required for communication purposes DefinitionIndicates whether an interpreter is required for communication purposes- True / False? A stream of bytes, base64 encoded The 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 idPractitioner.extension:nhsCommunication.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-NHSCommunication-1Mappings
| |||
value[x] | 0..0 | There are no (further) constraints on this element Element idPractitioner.extension:nhsCommunication.value[x]Short description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.identifierShort description A identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent. Unordered, Open At End, by system(Value) Mappings
| ||
sdsUserID | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserIDShort description A identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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 idPractitioner.identifier:sdsUserID.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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. https://fhir.nhs.uk/Id/sds-user-idExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.identifier:sdsUserID.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) Mappings
| ||
sdsRoleProfileID | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileIDShort description A identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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 idPractitioner.identifier:sdsRoleProfileID.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
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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) Mappings
| ||
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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. https://fhir.nhs.uk/Id/sds-role-profile-idExamples General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.identifier:sdsRoleProfileID.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) Mappings
| ||
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPractitioner.activeShort description Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. Default is true. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. trueMappings
| ||
name | S Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idPractitioner.nameShort description The name(s) associated with the practitioner DefinitionThe name(s) associated with the practitioner. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general select the value to be used in the ResourceReference.display based on this:
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.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 Mappings
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.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 Fixed valueofficialMappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
family | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.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).
| ||
given | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.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.
| ||
telecom | Σ | 0..* | ContactPoint | Element idPractitioner.telecomShort description A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person 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 These typically will have home numbers, or mobile numbers that are not role specific. Unordered, Open, by system(Value), use(Value) Mappings
| ||
workPhone | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPractitioner.telecom:workPhoneShort description A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person 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 These typically will have home numbers, or mobile numbers that are not role specific.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.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 idPractitioner.telecom:workPhone.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workPhone.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed valuephoneMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workPhone.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 Fixed valueworkMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.telecom:workPhone.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
workEmail | S Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPractitioner.telecom:workEmailShort description A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person 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 These typically will have home numbers, or mobile numbers that are not role specific.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.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 idPractitioner.telecom:workEmail.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 | Σ C | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workEmail.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. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Fixed value
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.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.
| ||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.telecom:workEmail.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 Fixed valueworkMappings
| ||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.telecom:workEmail.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
address | Σ | 0..* | Address | Element idPractitioner.addressShort description Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Unordered, Open, by use(Value) Mappings
| ||
workAddress | S Σ | 0..1 | Address | There are no (further) constraints on this element Element idPractitioner.address:workAddressShort description Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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 idPractitioner.address:workAddress.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
| |||
use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPractitioner.address:workAddress.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 Fixed valueworkExamples General homeMappings
| ||
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General 137 Nowhere Street, Erewhon 9132Mappings
| ||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General 137 Nowhere StreetMappings
| ||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonMappings
| ||
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General MadisonMappings
| ||
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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).
| ||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132Mappings
| ||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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.
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.address:workAddress.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. General { "start": "2010-03-23", "end": "2010-07-01" }Mappings
| ||
gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed to address the person correctly. The gender of a person used for administrative purposes. Administrative Gender (required) Mappings
| ||
birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idPractitioner.birthDateShort description The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification.
| ||
photo | 0..* | Attachment | There are no (further) constraints on this element Element idPractitioner.photoShort description Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
| |||
qualification | S | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPractitioner.qualificationShort description Qualifications obtained by training and certification DefinitionQualifications obtained by training and certification.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.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 idPractitioner.qualification.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.
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.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.
| ||
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.qualification.identifierShort description An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.qualification.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 . Mappings
| ||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.qualification.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) Mappings
| ||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPractitioner.qualification.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.qualification.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.qualification.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. Reference(CareConnect-Organization-1) Mappings
| ||
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idPractitioner.qualification.codeShort description Coded representation of the qualification DefinitionCoded representation of the qualification. Specific qualification the practitioner has to provide a service v2 table 0360, Version 2.7 (example) Mappings
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.code.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 idPractitioner.qualification.code.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPractitioner.qualification.code.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.
| ||
text | Σ | 1..1 | string | Element idPractitioner.qualification.code.textShort description Plain text representation of the concept DefinitionTextual representation of the Practitioner's Role/Job Title - e.g. Discharge Nurse 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.
| ||
period | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.qualification.periodShort description Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked.
| |||
issuer | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idPractitioner.qualification.issuerShort description Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. Reference(CareConnect-Organization-1) Mappings
| |||
communication | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitioner.communicationShort description A language the practitioner is able to use in patient communication DefinitionA language the practitioner is able to use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language. Binding extensions
|
Practitioner Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-SHD-Practitioner-1 profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
Practitioner.name | 1..1 | string | Plain text representation of the care practitioner's name. Constraint: SHALL include a Practitioner.name.use = 'official' and a Practitioner.name.text = {full name} |
Practitioner.telecom | 0..* | ContactPoint | Constraint: Multiple may be provided, however Work Phone, Work Email MUST BE SUPPORTED |
Practitioner.telecom[workPhone] | 0..1 | ContactPoint | Constraint: For workPhone: Practitioner.telecom.system = 'phone'Practitioner.telecom.value = {Phone Number}Practitioner.telecom.use = 'work' |
Practitioner.telecom[workEmail] | 0..1 | ContactPoint | Constraint: For workEmail: Practitioner.telecom.system = 'email'Practitioner.telecom.value = {Email Address}Practitioner.telecom.use = 'work' |
Practitioner.address | 0..* | Address | Constraint: Multiple may be provided, however Work Address MUST BE SUPPORTED |
Practitioner.address[workAddress] | 0..1 | Address | Constraint: For workAddress:Practitioner.address.use = 'work'Practitioner.address.text = {Plain text representation of the address} |
Practitioner.qualification.code.text | 0..1 | string | Optional element to share a plain text representation of the Practitioner's Role/Job Title - (e.g. ReferralRequest.requester.agent.qualification.code.text='Discharge Nurse') |
SHD-QuestionnaireResponse-PreliminaryNeedsAssessment
This is the StructureDefinition overview for the SHD-QuestionnaireResponse-PreliminaryNeedsAssessment. This QuestionnaireResponse contains a Preliminary Needs Assessment completed by Hospital Staff and shared as part of a Supported Hospital Discharge with third partied (e.g. Social Care, Community Health).
The Preliminary Needs Assessment QuestionnaireResponse can be contained/referenced in the initial ReferralRequest, or can shared as a seperaet update subsequently with reference to the relevant ReferralRequest.id
The official URL for this profile is: https
Differential
The resource cannot be rendered.
Hybrid
The resource cannot be rendered.
Snapshot (default)
The resource cannot be rendered.
PreliminaryNeedsAssessment Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the SHD-QuestionnaireResponse-PreliminaryNeedsAssessment profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
QuestionnaireResponse.basedOn | 0..1 | Reference (CareConnect-SHD-ReferralRequest-1) | Reference to the ReferralRequest the Preliminary Needs Assessment resposnses relates to SHALL be provided if sent after the ReferralRequest |
QuestionnaireResponse.questionnaire.reference | 1..1 | string | Fixed Value: 'http |
QuestionnaireResponse.status | 1..1 | code | Fixed Value: 'completed' |
QuestionnaireResponse.authored | 1..1 | DateTime | The date/time the Preliminary Needs Assessment was completed / last updated by the health worker |
QuestionnaireResponse.item | 1..* | BackboneElement | MUST SUPPORT the items in the table below |
SHD-Questionnaire-PreliminaryNeedsAssessment Table
Questionnaire.url[0] | https://fhir.nottinghamshire.gov.uk/STU3/Questionnaire/SHD-Questionnaire-PreliminaryNeedsAssessment |
Questionnaire.version[0] | 0.0.1 |
Questionnaire.name[0] | SHD-Questionnaire-PreliminaryNeedsAssessment |
Questionnaire.title[0] | SHD-Questionnaire-PreliminaryNeedsAssessment |
Questionnaire.status[0] | draft |
Questionnaire.date[0] | 2020-04-21T17:59:11.362Z |
Questionnaire.publisher[0] | NottsCC |
Questionnaire.description[0] | Preliminary Needs Assessment completed by Hospital Staff and shared as part of a Supported Hospital Discharge with third partied (e.g. Social Care, Community Health) |
Questionnaire.purpose[0] | Preliminary Needs Assessment completed by Hospital Staff and shared as part of a Supported Hospital Discharge with third partied (e.g. Social Care, Community Health) |
Questionnaire.subjectType[0] | Patient |
Questionnaire.item[0].linkId[0] | 1 |
Questionnaire.item[0].text[0] | Capacity |
Questionnaire.item[0].type[0] | group |
Questionnaire.item[0].required[0] | False |
Questionnaire.item[0].item[0].linkId[0] | 1.1 |
Questionnaire.item[0].item[0].text[0] | Is the person able to give informed consent to their discharge arrangements? |
Questionnaire.item[0].item[0].type[0] | choice |
Questionnaire.item[0].item[0].required[0] | False |
Questionnaire.item[0].item[0].option[0].value[0].code[0] | yes |
Questionnaire.item[0].item[0].option[0].value[0].display[0] | Yes |
Questionnaire.item[0].item[0].option[1].value[0].code[0] | no |
Questionnaire.item[0].item[0].option[1].value[0].display[0] | No |
Questionnaire.item[0].item[0].option[2].value[0].code[0] | unable |
Questionnaire.item[0].item[0].option[2].value[0].display[0] | Unable |
Questionnaire.item[0].item[1].linkId[0] | 1.1.1 |
Questionnaire.item[0].item[1].text[0] | If not, give details and a mental capacity assessment is needed |
Questionnaire.item[0].item[1].type[0] | text |
Questionnaire.item[0].item[1].enableWhen[0].question[0] | 1.1 |
Questionnaire.item[0].item[1].enableWhen[0].answer[0].code[0] | no |
Questionnaire.item[0].item[1].enableWhen[1].question[0] | 1.1 |
Questionnaire.item[0].item[1].enableWhen[1].answer[0].code[0] | unable |
Questionnaire.item[0].item[1].required[0] | True |
Questionnaire.item[0].item[2].linkId[0] | 1.2 |
Questionnaire.item[0].item[2].text[0] | Deprivation of Liberty Safeguards: Will the person be deprived of their liberty? – i.e. under continuous supervision and control and not free to leave and not able to give informed consent to these arrangements. |
Questionnaire.item[0].item[2].type[0] | choice |
Questionnaire.item[0].item[2].required[0] | False |
Questionnaire.item[0].item[2].option[0].value[0].code[0] | yes |
Questionnaire.item[0].item[2].option[0].value[0].display[0] | Yes |
Questionnaire.item[0].item[2].option[1].value[0].code[0] | no |
Questionnaire.item[0].item[2].option[1].value[0].display[0] | No |
Questionnaire.item[0].item[3].linkId[0] | 1.2.1 |
Questionnaire.item[0].item[3].text[0] | If Yes- give details |
Questionnaire.item[0].item[3].type[0] | text |
Questionnaire.item[0].item[3].enableWhen[0].question[0] | 1.2 |
Questionnaire.item[0].item[3].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[0].item[3].required[0] | True |
Questionnaire.item[0].item[4].linkId[0] | 1.3 |
Questionnaire.item[0].item[4].text[0] | Are there any cognition or other risks? Any risks being left alone or with others |
Questionnaire.item[0].item[4].type[0] | choice |
Questionnaire.item[0].item[4].required[0] | False |
Questionnaire.item[0].item[4].option[0].value[0].code[0] | yes |
Questionnaire.item[0].item[4].option[0].value[0].display[0] | Yes |
Questionnaire.item[0].item[4].option[1].value[0].code[0] | no |
Questionnaire.item[0].item[4].option[1].value[0].display[0] | No |
Questionnaire.item[0].item[5].linkId[0] | 1.3.1 |
Questionnaire.item[0].item[5].text[0] | If Yes- give details |
Questionnaire.item[0].item[5].type[0] | text |
Questionnaire.item[0].item[5].enableWhen[0].question[0] | 1.3 |
Questionnaire.item[0].item[5].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[0].item[5].required[0] | True |
Questionnaire.item[1].linkId[0] | 2 |
Questionnaire.item[1].text[0] | Current Medical Needs to support discharge arrangements |
Questionnaire.item[1].type[0] | group |
Questionnaire.item[1].required[0] | False |
Questionnaire.item[1].item[0].linkId[0] | 2.1 |
Questionnaire.item[1].item[0].text[0] | Record any amendments or changes to medication not reflected on the GP record |
Questionnaire.item[1].item[0].type[0] | text |
Questionnaire.item[1].item[0].required[0] | False |
Questionnaire.item[1].item[1].linkId[0] | 2.2 |
Questionnaire.item[1].item[1].text[0] | Medical Equipment e.g. oxygen |
Questionnaire.item[1].item[1].type[0] | text |
Questionnaire.item[1].item[1].required[0] | False |
Questionnaire.item[1].item[2].linkId[0] | 2.3 |
Questionnaire.item[1].item[2].text[0] | Is support with medication required? |
Questionnaire.item[1].item[2].type[0] | choice |
Questionnaire.item[1].item[2].required[0] | False |
Questionnaire.item[1].item[2].option[0].value[0].code[0] | yes |
Questionnaire.item[1].item[2].option[0].value[0].display[0] | Yes |
Questionnaire.item[1].item[2].option[1].value[0].code[0] | no |
Questionnaire.item[1].item[2].option[1].value[0].display[0] | No |
Questionnaire.item[1].item[3].linkId[0] | 2.3.1 |
Questionnaire.item[1].item[3].text[0] | If Yes- give details, e.g Mediwallet |
Questionnaire.item[1].item[3].type[0] | text |
Questionnaire.item[1].item[3].enableWhen[0].question[0] | 2.3 |
Questionnaire.item[1].item[3].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[1].item[3].required[0] | True |
Questionnaire.item[1].item[4].linkId[0] | 2.4 |
Questionnaire.item[1].item[4].text[0] | Known Allergies |
Questionnaire.item[1].item[4].type[0] | text |
Questionnaire.item[1].item[4].required[0] | False |
Questionnaire.item[1].item[5].linkId[0] | 2.5 |
Questionnaire.item[1].item[5].text[0] | Other medical needs which impact discharge arrangements. Past Medical history e.g. COPD, Diabetes |
Questionnaire.item[1].item[5].type[0] | text |
Questionnaire.item[1].item[5].required[0] | False |
Questionnaire.item[1].item[6].linkId[0] | 2.6 |
Questionnaire.item[1].item[6].text[0] | Details of any tests or awaiting results for after discharge |
Questionnaire.item[1].item[6].type[0] | text |
Questionnaire.item[1].item[6].required[0] | False |
Questionnaire.item[1].item[7].linkId[0] | 2.7 |
Questionnaire.item[1].item[7].text[0] | Has a ReSPECT form been completed? |
Questionnaire.item[1].item[7].type[0] | choice |
Questionnaire.item[1].item[7].required[0] | False |
Questionnaire.item[1].item[7].option[0].value[0].code[0] | yes |
Questionnaire.item[1].item[7].option[0].value[0].display[0] | Yes |
Questionnaire.item[1].item[7].option[1].value[0].code[0] | no |
Questionnaire.item[1].item[7].option[1].value[0].display[0] | No |
Questionnaire.item[1].item[8].linkId[0] | 2.7.1 |
Questionnaire.item[1].item[8].text[0] | If Yes- details of ReSPECT form |
Questionnaire.item[1].item[8].type[0] | text |
Questionnaire.item[1].item[8].enableWhen[0].question[0] | 2.7 |
Questionnaire.item[1].item[8].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[1].item[8].required[0] | True |
Questionnaire.item[2].linkId[0] | 3 |
Questionnaire.item[2].text[0] | Living arrangements |
Questionnaire.item[2].type[0] | group |
Questionnaire.item[2].required[0] | False |
Questionnaire.item[2].item[0].linkId[0] | 3.1 |
Questionnaire.item[2].item[0].text[0] | Does the patient live alone? |
Questionnaire.item[2].item[0].type[0] | choice |
Questionnaire.item[2].item[0].required[0] | False |
Questionnaire.item[2].item[0].option[0].value[0].code[0] | yes |
Questionnaire.item[2].item[0].option[0].value[0].display[0] | Yes |
Questionnaire.item[2].item[0].option[1].value[0].code[0] | no |
Questionnaire.item[2].item[0].option[1].value[0].display[0] | No |
Questionnaire.item[2].item[1].linkId[0] | 3.2 |
Questionnaire.item[2].item[1].text[0] | Accommodation type and living arrangements. E.g. bungalow, who lives with, etc |
Questionnaire.item[2].item[1].type[0] | text |
Questionnaire.item[2].item[1].required[0] | False |
Questionnaire.item[2].item[2].linkId[0] | 3.3 |
Questionnaire.item[2].item[2].text[0] | Keysafe including number? |
Questionnaire.item[2].item[2].type[0] | text |
Questionnaire.item[2].item[2].required[0] | False |
Questionnaire.item[2].item[3].linkId[0] | 3.4 |
Questionnaire.item[2].item[3].text[0] | Lifeline or similar monitoring equipment? |
Questionnaire.item[2].item[3].type[0] | text |
Questionnaire.item[2].item[3].required[0] | False |
Questionnaire.item[2].item[4].linkId[0] | 3.5 |
Questionnaire.item[2].item[4].text[0] | Urgent accommodation risks and issues if known – only if this will prevent the discharge going ahead. E.g. EMAS concerns raised, family refusing discharge |
Questionnaire.item[2].item[4].type[0] | text |
Questionnaire.item[2].item[4].required[0] | False |
Questionnaire.item[3].linkId[0] | 4 |
Questionnaire.item[3].text[0] | Input from the person’s discharge care needs |
Questionnaire.item[3].type[0] | group |
Questionnaire.item[3].required[0] | False |
Questionnaire.item[3].item[0].linkId[0] | 4.1 |
Questionnaire.item[3].item[0].text[0] | Mobility Status - Can the person mobilise? |
Questionnaire.item[3].item[0].type[0] | choice |
Questionnaire.item[3].item[0].required[0] | False |
Questionnaire.item[3].item[0].option[0].value[0].code[0] | independently |
Questionnaire.item[3].item[0].option[0].value[0].display[0] | Independently |
Questionnaire.item[3].item[0].option[1].value[0].code[0] | with-aid |
Questionnaire.item[3].item[0].option[1].value[0].display[0] | With aid |
Questionnaire.item[3].item[1].linkId[0] | 4.1.1 |
Questionnaire.item[3].item[1].text[0] | If with aid please state the level of assistance required? |
Questionnaire.item[3].item[1].type[0] | text |
Questionnaire.item[3].item[1].enableWhen[0].question[0] | 4.1 |
Questionnaire.item[3].item[1].enableWhen[0].answer[0].code[0] | with-aid |
Questionnaire.item[3].item[1].required[0] | True |
Questionnaire.item[3].item[2].linkId[0] | 4.2 |
Questionnaire.item[3].item[2].text[0] | Is the patient able to safely /independently manage stairs? |
Questionnaire.item[3].item[2].type[0] | choice |
Questionnaire.item[3].item[2].required[0] | False |
Questionnaire.item[3].item[2].option[0].value[0].code[0] | yes |
Questionnaire.item[3].item[2].option[0].value[0].display[0] | Yes |
Questionnaire.item[3].item[2].option[1].value[0].code[0] | no |
Questionnaire.item[3].item[2].option[1].value[0].display[0] | No |
Questionnaire.item[3].item[2].option[2].value[0].code[0] | NA |
Questionnaire.item[3].item[2].option[2].value[0].display[0] | Not Applicable |
Questionnaire.item[3].item[3].linkId[0] | 4.3 |
Questionnaire.item[3].item[3].text[0] | Are there any steps at the person’s property? |
Questionnaire.item[3].item[3].type[0] | choice |
Questionnaire.item[3].item[3].required[0] | False |
Questionnaire.item[3].item[3].option[0].value[0].code[0] | yes |
Questionnaire.item[3].item[3].option[0].value[0].display[0] | Yes |
Questionnaire.item[3].item[3].option[1].value[0].code[0] | no |
Questionnaire.item[3].item[3].option[1].value[0].display[0] | No |
Questionnaire.item[3].item[3].option[2].value[0].code[0] | dont-know |
Questionnaire.item[3].item[3].option[2].value[0].display[0] | Don't Know |
Questionnaire.item[3].item[4].linkId[0] | 4.4 |
Questionnaire.item[3].item[4].text[0] | Is the patient able to transfer off the bed? |
Questionnaire.item[3].item[4].type[0] | choice |
Questionnaire.item[3].item[4].required[0] | False |
Questionnaire.item[3].item[4].option[0].value[0].code[0] | independently |
Questionnaire.item[3].item[4].option[0].value[0].display[0] | Independently |
Questionnaire.item[3].item[4].option[1].value[0].code[0] | with-equipment |
Questionnaire.item[3].item[4].option[1].value[0].display[0] | With Equipment |
Questionnaire.item[3].item[5].linkId[0] | 4.5 |
Questionnaire.item[3].item[5].text[0] | Is the patient able to transfer off the chair? |
Questionnaire.item[3].item[5].type[0] | choice |
Questionnaire.item[3].item[5].required[0] | False |
Questionnaire.item[3].item[5].option[0].value[0].code[0] | independently |
Questionnaire.item[3].item[5].option[0].value[0].display[0] | Independently |
Questionnaire.item[3].item[5].option[1].value[0].code[0] | with-equipment |
Questionnaire.item[3].item[5].option[1].value[0].display[0] | With Equipment |
Questionnaire.item[3].item[6].linkId[0] | 4.6 |
Questionnaire.item[3].item[6].text[0] | Is the patient able to transfer off the toilet? |
Questionnaire.item[3].item[6].type[0] | choice |
Questionnaire.item[3].item[6].required[0] | False |
Questionnaire.item[3].item[6].option[0].value[0].code[0] | independently |
Questionnaire.item[3].item[6].option[0].value[0].display[0] | Independently |
Questionnaire.item[3].item[6].option[1].value[0].code[0] | with-equipment |
Questionnaire.item[3].item[6].option[1].value[0].display[0] | With Equipment |
Questionnaire.item[3].item[7].linkId[0] | 4.7 |
Questionnaire.item[3].item[7].text[0] | If equipment selected on any of the above, has this equipment been ordered to ensure a safe discharge? |
Questionnaire.item[3].item[7].type[0] | choice |
Questionnaire.item[3].item[7].enableWhen[0].question[0] | 4.4 |
Questionnaire.item[3].item[7].enableWhen[0].answer[0].code[0] | with-equipment |
Questionnaire.item[3].item[7].enableWhen[1].question[0] | 4.5 |
Questionnaire.item[3].item[7].enableWhen[1].answer[0].code[0] | with-equipment |
Questionnaire.item[3].item[7].enableWhen[2].question[0] | 4.6 |
Questionnaire.item[3].item[7].enableWhen[2].answer[0].code[0] | with-equipment |
Questionnaire.item[3].item[7].required[0] | False |
Questionnaire.item[3].item[7].option[0].value[0].code[0] | yes |
Questionnaire.item[3].item[7].option[0].value[0].display[0] | Yes |
Questionnaire.item[3].item[7].option[1].value[0].code[0] | no |
Questionnaire.item[3].item[7].option[1].value[0].display[0] | No |
Questionnaire.item[3].item[8].linkId[0] | 4.8 |
Questionnaire.item[3].item[8].text[0] | How does the person feel they will transfer between areas of their home? (between bed and chair and toilet or bathroom, any steps at their property, between rooms etc)? |
Questionnaire.item[3].item[8].type[0] | text |
Questionnaire.item[3].item[8].required[0] | False |
Questionnaire.item[3].item[9].linkId[0] | 4.9 |
Questionnaire.item[3].item[9].text[0] | Can the person bear their own weight fully? |
Questionnaire.item[3].item[9].type[0] | choice |
Questionnaire.item[3].item[9].required[0] | False |
Questionnaire.item[3].item[9].option[0].value[0].code[0] | yes |
Questionnaire.item[3].item[9].option[0].value[0].display[0] | Yes |
Questionnaire.item[3].item[9].option[1].value[0].code[0] | no |
Questionnaire.item[3].item[9].option[1].value[0].display[0] | No |
Questionnaire.item[3].item[9].option[2].value[0].code[0] | partially |
Questionnaire.item[3].item[9].option[2].value[0].display[0] | Partially |
Questionnaire.item[3].item[10].linkId[0] | 4.9.1 |
Questionnaire.item[3].item[10].text[0] | Details if No or Partially |
Questionnaire.item[3].item[10].type[0] | text |
Questionnaire.item[3].item[10].enableWhen[0].question[0] | 4.9 |
Questionnaire.item[3].item[10].enableWhen[0].answer[0].code[0] | no |
Questionnaire.item[3].item[10].enableWhen[1].question[0] | 4.9 |
Questionnaire.item[3].item[10].enableWhen[1].answer[0].code[0] | partially |
Questionnaire.item[3].item[10].required[0] | True |
Questionnaire.item[3].item[11].linkId[0] | 4.10 |
Questionnaire.item[3].item[11].text[0] | Can the person prepare drinks or a meal for themselves at home? |
Questionnaire.item[3].item[11].type[0] | choice |
Questionnaire.item[3].item[11].required[0] | False |
Questionnaire.item[3].item[11].option[0].value[0].code[0] | yes |
Questionnaire.item[3].item[11].option[0].value[0].display[0] | Yes |
Questionnaire.item[3].item[11].option[1].value[0].code[0] | no |
Questionnaire.item[3].item[11].option[1].value[0].display[0] | No |
Questionnaire.item[3].item[12].linkId[0] | 4.10.1 |
Questionnaire.item[3].item[12].text[0] | Please give details of alternative (e.g. meals delivery/ family support) |
Questionnaire.item[3].item[12].type[0] | text |
Questionnaire.item[3].item[12].enableWhen[0].question[0] | 4.10 |
Questionnaire.item[3].item[12].enableWhen[0].answer[0].code[0] | no |
Questionnaire.item[3].item[12].required[0] | True |
Questionnaire.item[3].item[13].linkId[0] | 4.11 |
Questionnaire.item[3].item[13].text[0] | Does the person have any difficulty swallowing? |
Questionnaire.item[3].item[13].type[0] | choice |
Questionnaire.item[3].item[13].required[0] | False |
Questionnaire.item[3].item[13].option[0].value[0].code[0] | yes |
Questionnaire.item[3].item[13].option[0].value[0].display[0] | Yes |
Questionnaire.item[3].item[13].option[1].value[0].code[0] | no |
Questionnaire.item[3].item[13].option[1].value[0].display[0] | No |
Questionnaire.item[3].item[14].linkId[0] | 4.11.1 |
Questionnaire.item[3].item[14].text[0] | If Yes- give details |
Questionnaire.item[3].item[14].type[0] | text |
Questionnaire.item[3].item[14].enableWhen[0].question[0] | 4.11 |
Questionnaire.item[3].item[14].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[3].item[14].required[0] | True |
Questionnaire.item[3].item[15].linkId[0] | 4.12 |
Questionnaire.item[3].item[15].text[0] | Is the person able to wash and dress themselves on discharge? |
Questionnaire.item[3].item[15].type[0] | choice |
Questionnaire.item[3].item[15].required[0] | False |
Questionnaire.item[3].item[15].option[0].value[0].code[0] | yes |
Questionnaire.item[3].item[15].option[0].value[0].display[0] | Yes |
Questionnaire.item[3].item[15].option[1].value[0].code[0] | no |
Questionnaire.item[3].item[15].option[1].value[0].display[0] | No |
Questionnaire.item[3].item[16].linkId[0] | 4.12.1 |
Questionnaire.item[3].item[16].text[0] | If No- give details |
Questionnaire.item[3].item[16].type[0] | text |
Questionnaire.item[3].item[16].enableWhen[0].question[0] | 4.12 |
Questionnaire.item[3].item[16].enableWhen[0].answer[0].code[0] | no |
Questionnaire.item[3].item[16].required[0] | True |
Questionnaire.item[3].item[17].linkId[0] | 4.13 |
Questionnaire.item[3].item[17].text[0] | What does the person want to ideally achieve? e.g. return to independence, support at home etc |
Questionnaire.item[3].item[17].type[0] | text |
Questionnaire.item[3].item[17].required[0] | False |
Questionnaire.item[4].linkId[0] | 5 |
Questionnaire.item[4].text[0] | Specialist Input needed after discharge |
Questionnaire.item[4].type[0] | group |
Questionnaire.item[4].required[0] | False |
Questionnaire.item[4].item[0].linkId[0] | 5.1 |
Questionnaire.item[4].item[0].text[0] | Does the person have any wounds or sores that need to be dressed or managed? (awareness for providers on bed sores etc) |
Questionnaire.item[4].item[0].type[0] | choice |
Questionnaire.item[4].item[0].required[0] | False |
Questionnaire.item[4].item[0].option[0].value[0].code[0] | yes |
Questionnaire.item[4].item[0].option[0].value[0].display[0] | Yes |
Questionnaire.item[4].item[0].option[1].value[0].code[0] | no |
Questionnaire.item[4].item[0].option[1].value[0].display[0] | No |
Questionnaire.item[4].item[1].linkId[0] | 5.1.1 |
Questionnaire.item[4].item[1].text[0] | If Yes give details |
Questionnaire.item[4].item[1].type[0] | text |
Questionnaire.item[4].item[1].enableWhen[0].question[0] | 5.1 |
Questionnaire.item[4].item[1].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[4].item[1].required[0] | True |
Questionnaire.item[4].item[2].linkId[0] | 5.2 |
Questionnaire.item[4].item[2].text[0] | Does the person have any Continence needs? |
Questionnaire.item[4].item[2].type[0] | choice |
Questionnaire.item[4].item[2].required[0] | False |
Questionnaire.item[4].item[2].option[0].value[0].code[0] | yes |
Questionnaire.item[4].item[2].option[0].value[0].display[0] | Yes |
Questionnaire.item[4].item[2].option[1].value[0].code[0] | no |
Questionnaire.item[4].item[2].option[1].value[0].display[0] | No |
Questionnaire.item[4].item[3].linkId[0] | 5.2.1 |
Questionnaire.item[4].item[3].text[0] | If Yes give details |
Questionnaire.item[4].item[3].type[0] | text |
Questionnaire.item[4].item[3].enableWhen[0].question[0] | 5.2 |
Questionnaire.item[4].item[3].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[4].item[3].required[0] | True |
Questionnaire.item[4].item[4].linkId[0] | 5.3 |
Questionnaire.item[4].item[4].text[0] | How will the person support themselves overnight between visits? (e.g. if needs toilet in the night) |
Questionnaire.item[4].item[4].type[0] | text |
Questionnaire.item[4].item[4].required[0] | False |
Questionnaire.item[4].item[5].linkId[0] | 5.4 |
Questionnaire.item[4].item[5].text[0] | Can the person fully communicate their needs? |
Questionnaire.item[4].item[5].type[0] | choice |
Questionnaire.item[4].item[5].required[0] | False |
Questionnaire.item[4].item[5].option[0].value[0].code[0] | yes |
Questionnaire.item[4].item[5].option[0].value[0].display[0] | Yes |
Questionnaire.item[4].item[5].option[1].value[0].code[0] | no |
Questionnaire.item[4].item[5].option[1].value[0].display[0] | No |
Questionnaire.item[4].item[6].linkId[0] | 5.4.1 |
Questionnaire.item[4].item[6].text[0] | If No please give communication needs. e.g. translator, carer support |
Questionnaire.item[4].item[6].type[0] | text |
Questionnaire.item[4].item[6].enableWhen[0].question[0] | 5.4 |
Questionnaire.item[4].item[6].enableWhen[0].answer[0].code[0] | no |
Questionnaire.item[4].item[6].required[0] | True |
Questionnaire.item[4].item[7].linkId[0] | 5.5 |
Questionnaire.item[4].item[7].text[0] | Has transport been arranged for this person? |
Questionnaire.item[4].item[7].type[0] | choice |
Questionnaire.item[4].item[7].required[0] | False |
Questionnaire.item[4].item[7].option[0].value[0].code[0] | yes |
Questionnaire.item[4].item[7].option[0].value[0].display[0] | Yes |
Questionnaire.item[4].item[7].option[1].value[0].code[0] | no |
Questionnaire.item[4].item[7].option[1].value[0].display[0] | No |
Questionnaire.item[4].item[8].linkId[0] | 5.5.1 |
Questionnaire.item[4].item[8].text[0] | If Yes date and time booked for |
Questionnaire.item[4].item[8].type[0] | dateTime |
Questionnaire.item[4].item[8].enableWhen[0].question[0] | 5.5 |
Questionnaire.item[4].item[8].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[4].item[8].required[0] | True |
Questionnaire.item[5].linkId[0] | 6 |
Questionnaire.item[5].text[0] | Additional Information |
Questionnaire.item[5].type[0] | group |
Questionnaire.item[5].required[0] | False |
Questionnaire.item[5].item[0].linkId[0] | 6.1 |
Questionnaire.item[5].item[0].text[0] | Please use this section to provide any other additional information that is relevant to the discharge |
Questionnaire.item[5].item[0].type[0] | text |
Questionnaire.item[5].item[0].required[0] | False |
SHD-QuestionnaireResponse-COVID19
This is the StructureDefinition overview for the SHD-QuestionnaireResponse-COVID19. This QuestionnaireResponse is completed by Hospital Staff, to share details of any COVID-19 related information with third parties as part of a Supported Hospital Discharge.
The COVID-19 QuestionnaireResponse can be contained/referenced in the initial ReferralRequest, or can shared as a seperaet update subsequently with reference to the relevant ReferralRequest.id
The official URL for this profile is: https
Differential
The resource cannot be rendered.
Hybrid
The resource cannot be rendered.
Snapshot (default)
The resource cannot be rendered.
COVID19 Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the SHD-QuestionnaireResponse-COVID19 profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
QuestionnaireResponse.basedOn | 0..1 | Reference (CareConnect-SHD-ReferralRequest-1) | Reference to the ReferralRequest the COVID-19 responses relates to SHALL be provided if sent after the ReferralRequest |
QuestionnaireResponse.questionnaire.reference | 1..1 | string | Fixed Value: 'http |
QuestionnaireResponse.status | 1..1 | code | Fixed Value: 'completed' |
QuestionnaireResponse.authored | 1..1 | DateTime | The date/time the COVID-19 QuestionnaireResponse was completed / last updated by the health worker |
QuestionnaireResponse.item | 1..* | BackboneElement | MUST SUPPORT the items in the table below |
SHD-Questionnaire-COVID19 Table
Questionnaire.url[0] | https://fhir.nottinghamshire.gov.uk/STU3/Questionnaire/SHD-Questionnaire-COVID19 |
Questionnaire.version[0] | 0.0.1 |
Questionnaire.name[0] | SHD-Questionnaire-COVID19 |
Questionnaire.title[0] | SHD-Questionnaire-COVID19 |
Questionnaire.status[0] | draft |
Questionnaire.date[0] | 2020-04-21T17:59:11.362Z |
Questionnaire.publisher[0] | NottsCC |
Questionnaire.description[0] | Questionnaire completed by Hospital Staff, to share details of any COVID-19 related information with third parties as part of a Supported Hospital Discharge |
Questionnaire.purpose[0] | Questionnaire completed by Hospital Staff, to share details of any COVID-19 related information with third parties as part of a Supported Hospital Discharge |
Questionnaire.subjectType[0] | Patient |
Questionnaire.item[0].linkId[0] | 1 |
Questionnaire.item[0].text[0] | Covid 19 Emergency Humanitarian response |
Questionnaire.item[0].type[0] | group |
Questionnaire.item[0].required[0] | False |
Questionnaire.item[0].item[0].linkId[0] | 1.1 |
Questionnaire.item[0].item[0].text[0] | What is the person’s Covid 19 Test result? |
Questionnaire.item[0].item[0].type[0] | choice |
Questionnaire.item[0].item[0].required[0] | False |
Questionnaire.item[0].item[0].option[0].value[0].code[0] | untested |
Questionnaire.item[0].item[0].option[0].value[0].display[0] | Untested |
Questionnaire.item[0].item[0].option[1].value[0].code[0] | positive |
Questionnaire.item[0].item[0].option[1].value[0].display[0] | Positive |
Questionnaire.item[0].item[0].option[2].value[0].code[0] | negative |
Questionnaire.item[0].item[0].option[2].value[0].display[0] | Negative |
Questionnaire.item[0].item[0].option[3].value[0].code[0] | awaiting-result |
Questionnaire.item[0].item[0].option[3].value[0].display[0] | Awaiting Result |
Questionnaire.item[0].item[1].linkId[0] | 1.2 |
Questionnaire.item[0].item[1].text[0] | Will the person be self-isolating on discharge? |
Questionnaire.item[0].item[1].type[0] | choice |
Questionnaire.item[0].item[1].required[0] | False |
Questionnaire.item[0].item[1].option[0].value[0].code[0] | yes |
Questionnaire.item[0].item[1].option[0].value[0].display[0] | Yes |
Questionnaire.item[0].item[1].option[1].value[0].code[0] | no |
Questionnaire.item[0].item[1].option[1].value[0].display[0] | No |
Questionnaire.item[0].item[2].linkId[0] | 1.2.1 |
Questionnaire.item[0].item[2].text[0] | If Yes – Why and for how long? (E.g shielding or in a vulnerable category) |
Questionnaire.item[0].item[2].type[0] | text |
Questionnaire.item[0].item[2].enableWhen[0].question[0] | 1.2 |
Questionnaire.item[0].item[2].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[0].item[2].required[0] | True |
Questionnaire.item[0].item[3].linkId[0] | 1.3 |
Questionnaire.item[0].item[3].text[0] | Does the person need food delivery or shopping support? |
Questionnaire.item[0].item[3].type[0] | choice |
Questionnaire.item[0].item[3].required[0] | False |
Questionnaire.item[0].item[3].option[0].value[0].code[0] | yes |
Questionnaire.item[0].item[3].option[0].value[0].display[0] | Yes |
Questionnaire.item[0].item[3].option[1].value[0].code[0] | no |
Questionnaire.item[0].item[3].option[1].value[0].display[0] | No |
Questionnaire.item[0].item[4].linkId[0] | 1.3.1 |
Questionnaire.item[0].item[4].text[0] | If Yes- give details |
Questionnaire.item[0].item[4].type[0] | text |
Questionnaire.item[0].item[4].enableWhen[0].question[0] | 1.3 |
Questionnaire.item[0].item[4].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[0].item[4].required[0] | True |
Questionnaire.item[0].item[5].linkId[0] | 1.4 |
Questionnaire.item[0].item[5].text[0] | Does the person need medication delivery support? |
Questionnaire.item[0].item[5].type[0] | choice |
Questionnaire.item[0].item[5].required[0] | False |
Questionnaire.item[0].item[5].option[0].value[0].code[0] | yes |
Questionnaire.item[0].item[5].option[0].value[0].display[0] | Yes |
Questionnaire.item[0].item[5].option[1].value[0].code[0] | no |
Questionnaire.item[0].item[5].option[1].value[0].display[0] | No |
Questionnaire.item[0].item[6].linkId[0] | 1.4.1 |
Questionnaire.item[0].item[6].text[0] | If Yes- give details |
Questionnaire.item[0].item[6].type[0] | text |
Questionnaire.item[0].item[6].enableWhen[0].question[0] | 1.4 |
Questionnaire.item[0].item[6].enableWhen[0].answer[0].code[0] | yes |
Questionnaire.item[0].item[6].required[0] | True |
SHD-QuestionnaireResponse-AssessmentNotice
This is the StructureDefinition overview for the SHD-QuestionnaireResponse-AssessmentNotice
The official URL for this profile is: https
Differential
The resource cannot be rendered.
Hybrid
The resource cannot be rendered.
Snapshot (default)
The resource cannot be rendered.
AssessmentNotice Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the SHD-QuestionnaireResponse-AssessmentNotice profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
QuestionnaireResponse.basedOn | 0..1 | Reference (CareConnect-SHD-ReferralRequest-1) | Reference to the ReferralRequest the Assessment Notice relates to SHALL be provided if sent after the ReferralRequest |
QuestionnaireResponse.questionnaire.reference | 1..1 | string | Fixed Value: 'http |
QuestionnaireResponse.status | 1..1 | code | Fixed Value: 'completed' |
QuestionnaireResponse.authored | 1..1 | DateTime | The date/time the Assessment Notice was actually issued/given to the Local Authority (this could be later than it was completed by the health worker) |
QuestionnaireResponse.item | 6..6 | BackboneElement | MUST SUPPORT the items in the table below |
SHD-Questionnaire-AssessmentNotice Table
Questionnaire.text[0].status[0] | additional |
Questionnaire.text[0].div[0] | <div xmlns="http://www.w3.org/1999/xhtml">This example is a copy of the Questionnaire resource referrenced in the SHD-QuestionnaireResponse-AssessmentNotice Profile, it provides additional details regarding the item answer types and any bindings </div> |
Questionnaire.url[0] | https://fhir.nottinghamshire.gov.uk/STU3/Questionnaire/SHD-Questionnaire-AssessmentNotice |
Questionnaire.name[0] | SHD-Questionnaire-AssessmentNotice |
Questionnaire.title[0] | SHD-Questionnaire-AssessmentNotice |
Questionnaire.status[0] | active |
Questionnaire.description[0] | NOTICE OF REQUEST FOR Assessment under The Care and Support (Discharge of Hospital Patients) Regulations 2014 |
Questionnaire.item[0].linkId[0] | 1.1 |
Questionnaire.item[0].text[0] | Name of person who completed the Assessment Notice |
Questionnaire.item[0].type[0] | string |
Questionnaire.item[0].required[0] | True |
Questionnaire.item[1].linkId[0] | 2.1 |
Questionnaire.item[1].text[0] | Has the patient been consulted regarding this Assessment Notice? |
Questionnaire.item[1].type[0] | boolean |
Questionnaire.item[1].required[0] | True |
Questionnaire.item[2].linkId[0] | 2.2 |
Questionnaire.item[2].text[0] | Has the patient's carer (if applicable) been consulted regarding the Assessment Notice? |
Questionnaire.item[2].type[0] | choice |
Questionnaire.item[2].required[0] | True |
Questionnaire.item[2].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/SHD-CarerConsultation |
Questionnaire.item[3].linkId[0] | 3.1 |
Questionnaire.item[3].text[0] | Has the patient consented to this Assessment Notice? |
Questionnaire.item[3].type[0] | choice |
Questionnaire.item[3].required[0] | True |
Questionnaire.item[3].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/SHD-PatientConsent |
Questionnaire.item[4].linkId[0] | 3.2 |
Questionnaire.item[4].text[0] | What is the source of the third party consent for this assessment notice? |
Questionnaire.item[4].type[0] | choice |
Questionnaire.item[4].required[0] | True |
Questionnaire.item[4].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/SHD-ThirdPartyConsentSource |
Questionnaire.item[5].linkId[0] | 4.1 |
Questionnaire.item[5].text[0] | Has the provision of NHS Continuing Health Care been considered? |
Questionnaire.item[5].type[0] | boolean |
Questionnaire.item[5].required[0] | True |
SHD-QuestionnaireResponse-CHCChecklist
This is the StructureDefinition overview for the SHD-QuestionnaireResponse-CHCChecklist
The official URL for this profile is: https
Differential
The resource cannot be rendered.
Hybrid
The resource cannot be rendered.
Snapshot (default)
The resource cannot be rendered.
CHCChecklist Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the SHD-QuestionnaireResponse-CHCChecklist profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
QuestionnaireResponse.basedOn | 0..1 | Reference (CareConnect-SHD-ReferralRequest-1) | Reference to the ReferralRequest the CHC Checklist relates to SHALL be provided if sent after the ReferralRequest |
QuestionnaireResponse.questionnaire.reference | 1..1 | string | Fixed Value: 'http |
QuestionnaireResponse.status | 1..1 | code | See use case guidance for any specific business context constriants. |
QuestionnaireResponse.authored | 1..1 | DateTime | The date/time the CHC Checklist was completed/amended by the assessor |
QuestionnaireResponse.item | 27..32 | BackboneElement | MUST SUPPORT the items in the table below |
SHD-Questionnaire-CHCChecklist Table
Questionnaire.url[0] | https://fhir.nottinghamshire.gov.uk/STU3/Questionnaire/SHD-Questionnaire-CHCChecklist |
Questionnaire.version[0] | 0.0.1 |
Questionnaire.name[0] | NHS Continuing Healthcare Checklist |
Questionnaire.title[0] | NHS Continuing Healthcare Checklist |
Questionnaire.status[0] | active |
Questionnaire.description[0] | NHS Continuing Healthcare Checklist |
Questionnaire.item[0].linkId[0] | 1.1 |
Questionnaire.item[0].text[0] | Name of the assessor(s) who completed the CHC Checklist |
Questionnaire.item[0].type[0] | string |
Questionnaire.item[0].required[0] | True |
Questionnaire.item[1].linkId[0] | 1.2 |
Questionnaire.item[1].text[0] | Contact details of assessors (name, role, organisation, telephone number, email address) |
Questionnaire.item[1].type[0] | string |
Questionnaire.item[1].required[0] | False |
Questionnaire.item[2].linkId[0] | 1.3 |
Questionnaire.item[2].text[0] | Was the individual involved in the completion of the Checklist? |
Questionnaire.item[2].type[0] | boolean |
Questionnaire.item[2].required[0] | True |
Questionnaire.item[3].linkId[0] | 1.4 |
Questionnaire.item[3].text[0] | Was the individual offered the opportunity to have a representative such as a family member or other advocate present when the checklist was completed? |
Questionnaire.item[3].type[0] | boolean |
Questionnaire.item[3].required[0] | True |
Questionnaire.item[4].linkId[0] | 1.5 |
Questionnaire.item[4].text[0] | If yes, did the representative attend the completion of the Checklist? |
Questionnaire.item[4].type[0] | boolean |
Questionnaire.item[4].enableWhen[0].question[0] | 1.4 |
Questionnaire.item[4].enableWhen[0].answer[0] | True |
Questionnaire.item[4].required[0] | True |
Questionnaire.item[5].linkId[0] | 1.6 |
Questionnaire.item[5].text[0] | Please give the contact details of the representative (name, address and telephone number) |
Questionnaire.item[5].type[0] | string |
Questionnaire.item[5].enableWhen[0].question[0] | 1.5 |
Questionnaire.item[5].enableWhen[0].answer[0] | True |
Questionnaire.item[5].required[0] | True |
Questionnaire.item[6].linkId[0] | 1.7 |
Questionnaire.item[6].text[0] | Did you explain to the individual how their personal information will be shared with the different organisations involved in their care, and did they consent to this information sharing? |
Questionnaire.item[6].type[0] | boolean |
Questionnaire.item[6].required[0] | False |
Questionnaire.item[7].linkId[0] | 2.1 |
Questionnaire.item[7].text[0] | 'Behaviour' Domain Level Score |
Questionnaire.item[7].type[0] | choice |
Questionnaire.item[7].required[0] | True |
Questionnaire.item[7].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[8].linkId[0] | 2.2 |
Questionnaire.item[8].text[0] | Evidence to support 'Behaviour' Domain Level |
Questionnaire.item[8].type[0] | string |
Questionnaire.item[8].required[0] | True |
Questionnaire.item[9].linkId[0] | 2.3 |
Questionnaire.item[9].text[0] | 'Cognition' Domain Level Score |
Questionnaire.item[9].type[0] | choice |
Questionnaire.item[9].required[0] | True |
Questionnaire.item[9].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[10].linkId[0] | 2.4 |
Questionnaire.item[10].text[0] | Evidence to support 'Cognition' Domain Level |
Questionnaire.item[10].type[0] | string |
Questionnaire.item[10].required[0] | True |
Questionnaire.item[11].linkId[0] | 2.5 |
Questionnaire.item[11].text[0] | 'Psychological/Emotional' Domain Level Score |
Questionnaire.item[11].type[0] | choice |
Questionnaire.item[11].required[0] | True |
Questionnaire.item[11].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[12].linkId[0] | 2.6 |
Questionnaire.item[12].text[0] | Evidence to support 'Psychological/Emotional' Domain Level |
Questionnaire.item[12].type[0] | string |
Questionnaire.item[12].required[0] | True |
Questionnaire.item[13].linkId[0] | 2.7 |
Questionnaire.item[13].text[0] | 'Communication' Domain Level Score |
Questionnaire.item[13].type[0] | choice |
Questionnaire.item[13].required[0] | True |
Questionnaire.item[13].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[14].linkId[0] | 2.8 |
Questionnaire.item[14].text[0] | Evidence to support 'Communication' Domain Level |
Questionnaire.item[14].type[0] | string |
Questionnaire.item[14].required[0] | True |
Questionnaire.item[15].linkId[0] | 2.9 |
Questionnaire.item[15].text[0] | 'Mobility' Domain Level Score |
Questionnaire.item[15].type[0] | choice |
Questionnaire.item[15].required[0] | True |
Questionnaire.item[15].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[16].linkId[0] | 2.10 |
Questionnaire.item[16].text[0] | Evidence to support 'Mobility' Domain Level |
Questionnaire.item[16].type[0] | string |
Questionnaire.item[16].required[0] | True |
Questionnaire.item[17].linkId[0] | 2.11 |
Questionnaire.item[17].text[0] | 'Nutrition' Domain Level Score |
Questionnaire.item[17].type[0] | choice |
Questionnaire.item[17].required[0] | True |
Questionnaire.item[17].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[18].linkId[0] | 2.12 |
Questionnaire.item[18].text[0] | Evidence to support 'Nutrition' Domain Level |
Questionnaire.item[18].type[0] | string |
Questionnaire.item[18].required[0] | True |
Questionnaire.item[19].linkId[0] | 2.13 |
Questionnaire.item[19].text[0] | 'Continence' Domain Level Score |
Questionnaire.item[19].type[0] | choice |
Questionnaire.item[19].required[0] | True |
Questionnaire.item[19].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[20].linkId[0] | 2.14 |
Questionnaire.item[20].text[0] | Evidence to support 'Continence' Domain Level |
Questionnaire.item[20].type[0] | string |
Questionnaire.item[20].required[0] | True |
Questionnaire.item[21].linkId[0] | 2.15 |
Questionnaire.item[21].text[0] | 'Skin integrity' Domain Level Score |
Questionnaire.item[21].type[0] | choice |
Questionnaire.item[21].required[0] | True |
Questionnaire.item[21].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[22].linkId[0] | 2.16 |
Questionnaire.item[22].text[0] | Evidence to support 'Skin integrity' Domain Level |
Questionnaire.item[22].type[0] | string |
Questionnaire.item[22].required[0] | True |
Questionnaire.item[23].linkId[0] | 2.17 |
Questionnaire.item[23].text[0] | 'Breathing' Domain Level Score |
Questionnaire.item[23].type[0] | choice |
Questionnaire.item[23].required[0] | True |
Questionnaire.item[23].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[24].linkId[0] | 2.18 |
Questionnaire.item[24].text[0] | Evidence to support 'Breathing' Domain Level |
Questionnaire.item[24].type[0] | string |
Questionnaire.item[24].required[0] | True |
Questionnaire.item[25].linkId[0] | 2.19 |
Questionnaire.item[25].text[0] | 'Drug therapies and medication: symptom control' Domain Level Score |
Questionnaire.item[25].type[0] | choice |
Questionnaire.item[25].required[0] | True |
Questionnaire.item[25].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[26].linkId[0] | 2.20 |
Questionnaire.item[26].text[0] | Evidence to support 'Drug therapies and medication: symptom control' Domain Level |
Questionnaire.item[26].type[0] | string |
Questionnaire.item[26].required[0] | True |
Questionnaire.item[27].linkId[0] | 2.21 |
Questionnaire.item[27].text[0] | 'Altered states of consciousness' Domain Level Score |
Questionnaire.item[27].type[0] | choice |
Questionnaire.item[27].required[0] | True |
Questionnaire.item[27].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-DomainLevelScore |
Questionnaire.item[28].linkId[0] | 2.22 |
Questionnaire.item[28].text[0] | Evidence to support 'Altered states of consciousness' Domain Level |
Questionnaire.item[28].type[0] | string |
Questionnaire.item[28].required[0] | True |
Questionnaire.item[29].linkId[0] | 2.23 |
Questionnaire.item[29].text[0] | Total Score from Checklist |
Questionnaire.item[29].type[0] | string |
Questionnaire.item[29].required[0] | True |
Questionnaire.item[30].linkId[0] | 2.24 |
Questionnaire.item[30].text[0] | Outcome indicated by the Checklist |
Questionnaire.item[30].type[0] | choice |
Questionnaire.item[30].required[0] | True |
Questionnaire.item[30].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/CHC-Outcome |
Questionnaire.item[31].linkId[0] | 2.25 |
Questionnaire.item[31].text[0] | Rationale for decision |
Questionnaire.item[31].type[0] | string |
Questionnaire.item[31].required[0] | False |
SHD-QuestionnaireResponse-DischargeNotice
This is the StructureDefinition overview for the SHD-QuestionnaireResponse-DischargeNotice
The official URL for this profile is: https
Differential
The resource cannot be rendered.
Hybrid
The resource cannot be rendered.
Snapshot (default)
The resource cannot be rendered.
DischargeNotice Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the SHD-QuestionnaireResponse-DischargeNotice profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
QuestionnaireResponse.basedOn | 1..1 | Reference (CareConnect-SHD-ReferralRequest-1) | Reference to the ReferralRequest the Discharge Notice relates to SHALL be provided |
QuestionnaireResponse.questionnaire.reference | 1..1 | string | Fixed Value: 'http |
QuestionnaireResponse.status | 1..1 | code | See use case guidance for any specific business context constriants. |
QuestionnaireResponse.authored | 1..1 | DateTime | The date/time the Discharge Notice was actually issued/given to the Local Authority (this could be later than it was completd by the health worker)See use case guidance for any specific business context constriants. |
QuestionnaireResponse.item | 4..9 | BackboneElement | MUST SUPPORT the items in the table below |
SHD-Questionnaire-DischargeNotice Table
Questionnaire.url[0] | https://fhir.nottinghamshire.gov.uk/STU3/Questionnaire/SHD-Questionnaire-DischargeNotice |
Questionnaire.name[0] | SHD-Questionnaire-DischargeNotice |
Questionnaire.title[0] | SHD-Questionnaire-DischargeNotice |
Questionnaire.status[0] | active |
Questionnaire.description[0] | NOTICE OF REQUEST FOR Discharge under The Care and Support (Discharge of Hospital Patients) Regulations 2014 |
Questionnaire.item[0].linkId[0] | 1.1 |
Questionnaire.item[0].text[0] | Name of person who completed the Discharge Notice |
Questionnaire.item[0].type[0] | string |
Questionnaire.item[0].required[0] | True |
Questionnaire.item[1].linkId[0] | 1.2 |
Questionnaire.item[1].text[0] | Proposed Discharge Date |
Questionnaire.item[1].type[0] | date |
Questionnaire.item[1].required[0] | True |
Questionnaire.item[2].linkId[0] | 2.1 |
Questionnaire.item[2].text[0] | Has the patient been consulted regarding the proposed discharge date? |
Questionnaire.item[2].type[0] | boolean |
Questionnaire.item[2].required[0] | True |
Questionnaire.item[3].linkId[0] | 2.2 |
Questionnaire.item[3].text[0] | Has the patient's carer (if applicable) been consulted regarding the proposed discharge date? |
Questionnaire.item[3].type[0] | choice |
Questionnaire.item[3].required[0] | True |
Questionnaire.item[3].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/SHD-CarerConsultation |
Questionnaire.item[4].linkId[0] | 3.1 |
Questionnaire.item[4].text[0] | Have all health action required for discharge been agreed and/or completed? |
Questionnaire.item[4].type[0] | boolean |
Questionnaire.item[4].required[0] | False |
Questionnaire.item[5].linkId[0] | 3.2 |
Questionnaire.item[5].text[0] | Details of health actions completed and any outstanding arrangements that the discharge is dependent upon. |
Questionnaire.item[5].type[0] | string |
Questionnaire.item[5].required[0] | False |
Questionnaire.item[6].linkId[0] | 4.1 |
Questionnaire.item[6].text[0] | Date Discharge Notice Withdrawn |
Questionnaire.item[6].type[0] | dateTime |
Questionnaire.item[6].required[0] | False |
Questionnaire.item[7].linkId[0] | 4.2 |
Questionnaire.item[7].text[0] | Reason for withdrawal |
Questionnaire.item[7].type[0] | choice |
Questionnaire.item[7].enableWhen[0].question[0] | 4.1 |
Questionnaire.item[7].enableWhen[0].hasAnswer[0] | True |
Questionnaire.item[7].required[0] | True |
Questionnaire.item[7].options[0].reference[0] | https://fhir.nottinghamshire.gov.uk/STU3/valueset/SHD-WithdrawalReason |
Questionnaire.item[8].linkId[0] | 4.3 |
Questionnaire.item[8].text[0] | Please specify details for 'Other' reason for withdrawal |
Questionnaire.item[8].type[0] | string |
Questionnaire.item[8].enableWhen[0].question[0] | 4.2 |
Questionnaire.item[8].enableWhen[0].answer[0].system[0] | https://fhir.nottinghamshire.gov.uk/STU3/codesystem/SHD-CancellationReason |
Questionnaire.item[8].enableWhen[0].answer[0].code[0] | 13 |
Questionnaire.item[8].required[0] | True |
CareConnect-SHD-Communication-1
This is the StructureDefinition overview for the CareConnect-SHD-Communication-1
The official URL for this profile is: https
Differential
CareConnect-SHD-Communication-1 (Communication) | C | CareConnect-Communication-1 | There are no (further) constraints on this element Element idCommunicationShort description A record of information transmitted from a sender to a receiver DefinitionAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idCommunication.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 idCommunication.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
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCommunication.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 idCommunication.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 idCommunication.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
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idCommunication.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 idCommunication.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
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.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 | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCommunication.identifierShort description Unique identifier DefinitionIdentifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
definition | Σ C | 0..* | Reference(PlanDefinition | ActivityDefinition) | There are no (further) constraints on this element Element idCommunication.definitionShort description Instantiates protocol or definition DefinitionA protocol, guideline, or other definition that was adhered to in whole or in part by this communication event. 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(PlanDefinition | ActivityDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
basedOn | Σ C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.basedOnShort description Request fulfilled by this communication Alternate namesfulfills DefinitionAn order, proposal or plan fulfilled in whole or in part by this Communication. This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
partOf | Σ C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.partOfShort description Part of this action Alternate namescontainer DefinitionPart of this action. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | S Σ ?! | 1..1 | codeBindingFixed Value | Element idCommunication.statusShort description preparation | in-progress | suspended | aborted | completed | entered-in-error DefinitionThe status of the transmission. This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. The status of the communication. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
completedMappings
| ||
notDone | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idCommunication.notDoneShort description Communication did not occur DefinitionIf true, indicates that the described communication event did not actually occur. Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
notDoneReason | Σ C | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCommunication.notDoneReasonShort description Why communication did not occur DefinitionDescribes why the communication event did not occur in coded and/or textual form. 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. Codes for the reason why a communication was not done. CommunicationNotDoneReason (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, com-1 Constraints
| ||
category | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.categoryShort description Message category DefinitionThe type of message conveyed such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication may serve multiple purposes. Codes for general categories of communications such as alerts, instruction, etc. CommunicationCategory (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
medium | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.mediumShort description A channel of communication DefinitionA channel that was used for this communication (e.g. email, fax). 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. Codes for communication mediums such as phone, fax, email, in person, etc. v3 Code System ParticipationMode (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
subject | S Σ C | 0..1 | Reference(CareConnect-SHD-Patient-1) | Element idCommunication.subjectShort description Focus of message Alternate namespatient DefinitionThe patient or group that was the focus of this communication. 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-SHD-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
recipient | C | 0..* | Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | There are no (further) constraints on this element Element idCommunication.recipientShort description Message recipient DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). 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(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
topic | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.topicShort description Focal resources DefinitionThe resources which were responsible for or related to producing this communication. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
context | S Σ C | 1..1 | Reference(CareConnect-SHD-Encounter-1) | Element idCommunication.contextShort description Encounter or episode leading to message Alternate namesencounter DefinitionThe encounter within which the communication was sent. 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-SHD-Encounter-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 idCommunication.context.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 idCommunication.context.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
| |||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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: ref-1 Mappings
| ||
identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.context.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.context.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 . Mappings
| ||
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCommunication.context.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) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.context.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 Mappings
| |||
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.context.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 Mappings
| |||
system | Σ | 1..1 | uriFixed Value | Element idCommunication.context.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. https://fhir.nottinghamshire.gov.ukMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
code | Σ | 1..1 | codeFixed Value | Element idCommunication.context.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. SHD-EncounterMappings
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idCommunication.context.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCommunication.context.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idCommunication.context.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
sent | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.sentShort description When sent DefinitionThe time when this communication was sent. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
received | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.receivedShort description When received DefinitionThe time when this communication arrived at the destination. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
sender | C | 0..1 | Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | There are no (further) constraints on this element Element idCommunication.senderShort description Message sender DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. 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(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.reasonCodeShort description Indication for message DefinitionThe reason or justification for the communication. Textual reasons can be caprued using reasonCode.text. Codes for describing reasons for the occurrence of a communication. SNOMED CT Clinical Findings (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reasonReference | Σ C | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | There are no (further) constraints on this element Element idCommunication.reasonReferenceShort description Why was communication done? DefinitionIndicates another resource whose existence justifies this communication. 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-Observation-1 | CareConnect-Condition-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
payload | 0..* | BackboneElement | There are no (further) constraints on this element Element idCommunication.payloadShort description Message payload DefinitionText, attachment(s), or resource(s) that was communicated to the recipient. 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 idCommunication.payload.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 idCommunication.payload.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 idCommunication.payload.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
| ||
content[x] | 1..1 | There are no (further) constraints on this element Element idCommunication.payload.content[x]Short description Message part content DefinitionA communicated content (or for multi-part communications, one portion of the communication). 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
| ||||
contentString | string | There are no (further) constraints on this element Data type | ||||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||||
contentReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||||
note | S | 1..1 | Annotation | There are no (further) constraints on this element Element idCommunication.noteShort description Comments made about the communication DefinitionAdditional notes or commentary about the communication by the sender, receiver or other interested parties. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). 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 idCommunication.note.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 idCommunication.note.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
| |||
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idCommunication.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation.
| |||
authorString | string | There are no (further) constraints on this element Data type | ||||
authorReference | Reference(Practitioner | Patient | RelatedPerson) | There are no (further) constraints on this element Data type | ||||
time | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idCommunication.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
text | 1..1 | string | There are no (further) constraints on this element Element idCommunication.note.textShort description The annotation - text content DefinitionThe text of the annotation.
|
Hybrid
CareConnect-SHD-Communication-1 (Communication) | C | CareConnect-Communication-1 | There are no (further) constraints on this element Element idCommunicationShort description A record of information transmitted from a sender to a receiver DefinitionAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idCommunication.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 idCommunication.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
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCommunication.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 idCommunication.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 idCommunication.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
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idCommunication.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 idCommunication.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
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.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 | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCommunication.identifierShort description Unique identifier DefinitionIdentifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
definition | Σ C | 0..* | Reference(PlanDefinition | ActivityDefinition) | There are no (further) constraints on this element Element idCommunication.definitionShort description Instantiates protocol or definition DefinitionA protocol, guideline, or other definition that was adhered to in whole or in part by this communication event. 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(PlanDefinition | ActivityDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
basedOn | Σ C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.basedOnShort description Request fulfilled by this communication Alternate namesfulfills DefinitionAn order, proposal or plan fulfilled in whole or in part by this Communication. This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
partOf | Σ C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.partOfShort description Part of this action Alternate namescontainer DefinitionPart of this action. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | S Σ ?! | 1..1 | codeBindingFixed Value | Element idCommunication.statusShort description preparation | in-progress | suspended | aborted | completed | entered-in-error DefinitionThe status of the transmission. This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. The status of the communication. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
completedMappings
| ||
notDone | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idCommunication.notDoneShort description Communication did not occur DefinitionIf true, indicates that the described communication event did not actually occur. Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
notDoneReason | Σ C | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCommunication.notDoneReasonShort description Why communication did not occur DefinitionDescribes why the communication event did not occur in coded and/or textual form. 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. Codes for the reason why a communication was not done. CommunicationNotDoneReason (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, com-1 Constraints
| ||
category | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.categoryShort description Message category DefinitionThe type of message conveyed such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication may serve multiple purposes. Codes for general categories of communications such as alerts, instruction, etc. CommunicationCategory (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
medium | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.mediumShort description A channel of communication DefinitionA channel that was used for this communication (e.g. email, fax). 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. Codes for communication mediums such as phone, fax, email, in person, etc. v3 Code System ParticipationMode (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
subject | S Σ C | 0..1 | Reference(CareConnect-SHD-Patient-1) | Element idCommunication.subjectShort description Focus of message Alternate namespatient DefinitionThe patient or group that was the focus of this communication. 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-SHD-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
recipient | C | 0..* | Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | There are no (further) constraints on this element Element idCommunication.recipientShort description Message recipient DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). 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(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
topic | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.topicShort description Focal resources DefinitionThe resources which were responsible for or related to producing this communication. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
context | S Σ C | 1..1 | Reference(CareConnect-SHD-Encounter-1) | Element idCommunication.contextShort description Encounter or episode leading to message Alternate namesencounter DefinitionThe encounter within which the communication was sent. 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-SHD-Encounter-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 idCommunication.context.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 idCommunication.context.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
| |||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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: ref-1 Mappings
| ||
identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.context.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.context.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 . Mappings
| ||
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCommunication.context.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) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.context.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 Mappings
| |||
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.context.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 Mappings
| |||
system | Σ | 1..1 | uriFixed Value | Element idCommunication.context.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. https://fhir.nottinghamshire.gov.ukMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
code | Σ | 1..1 | codeFixed Value | Element idCommunication.context.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. SHD-EncounterMappings
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idCommunication.context.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCommunication.context.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idCommunication.context.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
sent | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.sentShort description When sent DefinitionThe time when this communication was sent. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
received | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.receivedShort description When received DefinitionThe time when this communication arrived at the destination. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
sender | C | 0..1 | Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | There are no (further) constraints on this element Element idCommunication.senderShort description Message sender DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. 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(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.reasonCodeShort description Indication for message DefinitionThe reason or justification for the communication. Textual reasons can be caprued using reasonCode.text. Codes for describing reasons for the occurrence of a communication. SNOMED CT Clinical Findings (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reasonReference | Σ C | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | There are no (further) constraints on this element Element idCommunication.reasonReferenceShort description Why was communication done? DefinitionIndicates another resource whose existence justifies this communication. 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-Observation-1 | CareConnect-Condition-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
payload | 0..* | BackboneElement | There are no (further) constraints on this element Element idCommunication.payloadShort description Message payload DefinitionText, attachment(s), or resource(s) that was communicated to the recipient. 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 idCommunication.payload.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 idCommunication.payload.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 idCommunication.payload.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
| ||
content[x] | 1..1 | There are no (further) constraints on this element Element idCommunication.payload.content[x]Short description Message part content DefinitionA communicated content (or for multi-part communications, one portion of the communication). 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
| ||||
contentString | string | There are no (further) constraints on this element Data type | ||||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||||
contentReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||||
note | S | 1..1 | Annotation | There are no (further) constraints on this element Element idCommunication.noteShort description Comments made about the communication DefinitionAdditional notes or commentary about the communication by the sender, receiver or other interested parties. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). 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 idCommunication.note.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 idCommunication.note.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
| |||
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idCommunication.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation.
| |||
authorString | string | There are no (further) constraints on this element Data type | ||||
authorReference | Reference(Practitioner | Patient | RelatedPerson) | There are no (further) constraints on this element Data type | ||||
time | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idCommunication.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
text | 1..1 | string | There are no (further) constraints on this element Element idCommunication.note.textShort description The annotation - text content DefinitionThe text of the annotation.
|
Snapshot (default)
CareConnect-SHD-Communication-1 (Communication) | C | CareConnect-Communication-1 | There are no (further) constraints on this element Element idCommunicationShort description A record of information transmitted from a sender to a receiver DefinitionAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idCommunication.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 idCommunication.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
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCommunication.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 idCommunication.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 idCommunication.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
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idCommunication.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 idCommunication.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
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.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 | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCommunication.identifierShort description Unique identifier DefinitionIdentifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
definition | Σ C | 0..* | Reference(PlanDefinition | ActivityDefinition) | There are no (further) constraints on this element Element idCommunication.definitionShort description Instantiates protocol or definition DefinitionA protocol, guideline, or other definition that was adhered to in whole or in part by this communication event. 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(PlanDefinition | ActivityDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
basedOn | Σ C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.basedOnShort description Request fulfilled by this communication Alternate namesfulfills DefinitionAn order, proposal or plan fulfilled in whole or in part by this Communication. This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ReferralRequest, MedicationRequest, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
partOf | Σ C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.partOfShort description Part of this action Alternate namescontainer DefinitionPart of this action. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | S Σ ?! | 1..1 | codeBindingFixed Value | Element idCommunication.statusShort description preparation | in-progress | suspended | aborted | completed | entered-in-error DefinitionThe status of the transmission. This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid. The status of the communication. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
completedMappings
| ||
notDone | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idCommunication.notDoneShort description Communication did not occur DefinitionIf true, indicates that the described communication event did not actually occur. Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
notDoneReason | Σ C | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCommunication.notDoneReasonShort description Why communication did not occur DefinitionDescribes why the communication event did not occur in coded and/or textual form. 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. Codes for the reason why a communication was not done. CommunicationNotDoneReason (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, com-1 Constraints
| ||
category | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.categoryShort description Message category DefinitionThe type of message conveyed such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication may serve multiple purposes. Codes for general categories of communications such as alerts, instruction, etc. CommunicationCategory (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
medium | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.mediumShort description A channel of communication DefinitionA channel that was used for this communication (e.g. email, fax). 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. Codes for communication mediums such as phone, fax, email, in person, etc. v3 Code System ParticipationMode (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
subject | S Σ C | 0..1 | Reference(CareConnect-SHD-Patient-1) | Element idCommunication.subjectShort description Focus of message Alternate namespatient DefinitionThe patient or group that was the focus of this communication. 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-SHD-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
recipient | C | 0..* | Reference(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | There are no (further) constraints on this element Element idCommunication.recipientShort description Message recipient DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). 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(Device | Group | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
topic | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunication.topicShort description Focal resources DefinitionThe resources which were responsible for or related to producing this communication. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
context | S Σ C | 1..1 | Reference(CareConnect-SHD-Encounter-1) | Element idCommunication.contextShort description Encounter or episode leading to message Alternate namesencounter DefinitionThe encounter within which the communication was sent. 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-SHD-Encounter-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 idCommunication.context.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 idCommunication.context.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
| |||
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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: ref-1 Mappings
| ||
identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.context.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 Mappings
| |||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idCommunication.context.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 . Mappings
| ||
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCommunication.context.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) Mappings
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.context.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 Mappings
| |||
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idCommunication.context.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 Mappings
| |||
system | Σ | 1..1 | uriFixed Value | Element idCommunication.context.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. https://fhir.nottinghamshire.gov.ukMappings
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
code | Σ | 1..1 | codeFixed Value | Element idCommunication.context.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. SHD-EncounterMappings
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idCommunication.context.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. General http://www.acme.com/identifiers/patientMappings
| ||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCommunication.context.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. General 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idCommunication.context.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCommunication.context.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.
| ||
sent | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.sentShort description When sent DefinitionThe time when this communication was sent. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
received | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunication.receivedShort description When received DefinitionThe time when this communication arrived at the destination. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
sender | C | 0..1 | Reference(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | There are no (further) constraints on this element Element idCommunication.senderShort description Message sender DefinitionThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. 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(Device | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunication.reasonCodeShort description Indication for message DefinitionThe reason or justification for the communication. Textual reasons can be caprued using reasonCode.text. Codes for describing reasons for the occurrence of a communication. SNOMED CT Clinical Findings (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reasonReference | Σ C | 0..* | Reference(CareConnect-Observation-1 | CareConnect-Condition-1) | There are no (further) constraints on this element Element idCommunication.reasonReferenceShort description Why was communication done? DefinitionIndicates another resource whose existence justifies this communication. 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-Observation-1 | CareConnect-Condition-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
payload | 0..* | BackboneElement | There are no (further) constraints on this element Element idCommunication.payloadShort description Message payload DefinitionText, attachment(s), or resource(s) that was communicated to the recipient. 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 idCommunication.payload.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 idCommunication.payload.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 idCommunication.payload.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
| ||
content[x] | 1..1 | There are no (further) constraints on this element Element idCommunication.payload.content[x]Short description Message part content DefinitionA communicated content (or for multi-part communications, one portion of the communication). 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
| ||||
contentString | string | There are no (further) constraints on this element Data type | ||||
contentAttachment | Attachment | There are no (further) constraints on this element Data type | ||||
contentReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||||
note | S | 1..1 | Annotation | There are no (further) constraints on this element Element idCommunication.noteShort description Comments made about the communication DefinitionAdditional notes or commentary about the communication by the sender, receiver or other interested parties. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). 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 idCommunication.note.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 idCommunication.note.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
| |||
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idCommunication.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation.
| |||
authorString | string | There are no (further) constraints on this element Data type | ||||
authorReference | Reference(Practitioner | Patient | RelatedPerson) | There are no (further) constraints on this element Data type | ||||
time | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idCommunication.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
text | 1..1 | string | There are no (further) constraints on this element Element idCommunication.note.textShort description The annotation - text content DefinitionThe text of the annotation.
|
Communication Data Mapping
The table below provides the generic business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-SHD-Communication-1 profile. However, please see the individual use case guidance for specifc constraints and context.
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
Communication.status | 1..1 | code | Binding EventStatus Fixed Value: 'completed' |
Communication.subject | 0..1 | Reference | Reference to Patient resource to whom the communication relates. |
Communication.context | 1..1 | Reference | Reference to Encounter resource for the the communication relates. |
Communication.context.identifier | 1..1 | Identifier | Logical reference for Encounter which was included in the CareConnect-SHD-ReferralRequest-1.Constraint: Communication.context.identifier.system = {Local Encounter System}Communication.context.identifier.value= {Encounter ID} |
Communication.context.identifier.type | 1..1 | CodeableConcept | Fixed Value: Communication.context.identifier.type.coding.system = 'http |
Communication.note | 1..1 | Annotation | MUST contain one note |
Communication.note.authorString | 0..1 | string | Optional field for details of who added the note/comment. |
Communication.note.time | 1..1 | dateTime | Date/Time communication was sent to the the Local Authority. SHALL be provided for any CareConnect-SHD-Communication-1 |
Communication.note.text | 1..1 | string | Plain text copy of the note/communication that is being shared with the Loacl Authority. SHALL be provided for any CareConnect-SHD-Communication-1 |