Encounter
This resource represents an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
| Encounter | C | Encounter | 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. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.
| |
| 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. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| 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 might not always be associated with version changes to the resource.
|
| 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
|
| 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). IETF language tag for a human language
| |
| 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 can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: dom-6 Constraints
|
| contained | C | 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 Mappings
|
| extension | C | 0..* | Extension | There are no (further) constraints on this element 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that 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 | Σ ?! 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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 | Σ | 1..* | Identifier | Element idEncounter.identifierShort description Identifier(s) by which this encounter is known DefinitionIdentifier(s) by which this encounter is known. Unordered, Open, by $this(Value) Constraints
|
| (All Slices) | The requirements in this element apply to all slices | |||
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.identifier.useShort description usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | 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. IdentifierTypeCodes (extensible) 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, an absolute 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | 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.
|
| assigner | Σ | 0..0 | Reference(Organization) | 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.
|
| recordIdentifier | Σ | 0..1 | Identifier | Element idEncounter.identifier:recordIdentifierShort description A unique identifier for this encounter record DefinitionA unique identifier for this encounter record
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.identifier:recordIdentifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.identifier:recordIdentifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idEncounter.identifier:recordIdentifier.useShort description usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.identifier:recordIdentifier.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. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.identifier:recordIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/record-identifierExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | Element idEncounter.identifier:recordIdentifier.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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Record ID SGH^10^1151874Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idEncounter.identifier:recordIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idEncounter.identifier:recordIdentifier.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.
|
| caseIdentifier | Σ | 0..* | Identifier | Element idEncounter.identifier:caseIdentifierShort description An identifier of the episode/case DefinitionAn identifier of the episode/case
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.identifier:caseIdentifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.identifier:caseIdentifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idEncounter.identifier:caseIdentifier.useShort description usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.identifier:caseIdentifier.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. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.identifier:caseIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/visit-identifierExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | Element idEncounter.identifier:caseIdentifier.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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Visit ID 6910032858DMappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idEncounter.identifier:caseIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idEncounter.identifier:caseIdentifier.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.
|
| movementIdentifier | Σ | 0..1 | Identifier | Element idEncounter.identifier:movementIdentifierShort description the sequence identifier of this encounter record within the episode/case identifier Definitionthe sequence identifier of this encounter record within the episode/case identifier
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.identifier:movementIdentifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.identifier:movementIdentifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idEncounter.identifier:movementIdentifier.useShort description usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.identifier:movementIdentifier.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. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.identifier:movementIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/movement-identifierExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | Element idEncounter.identifier:movementIdentifier.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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456movement sequence number 00001Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idEncounter.identifier:movementIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idEncounter.identifier:movementIdentifier.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.
|
| status | Σ ?! | 1..1 | codeBinding | Element idEncounter.statusShort description completed | cancelled DefinitionThe current state of the encounter (not the state of the patient within the encounter - that is subjectState). Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). Current state of the encounter. EncounterStatusValueSet (required) Constraints
Completed completedMappings
|
| class | Σ | 1..1 | CodeableConceptBinding | Element idEncounter.classShort description Classification of patient encounter context - e.g. Inpatient, outpatient DefinitionConcepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Classification of the encounter. PatientTypeValueSet (required) Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.class.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.class.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idEncounter.class.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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..0 | id | There are no (further) constraints on this element Element idEncounter.class.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.class.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.class.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/patient-typeMappings
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idEncounter.class.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 | Σ C | 1..1 | code | Element idEncounter.class.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Inpatient IOutpatient OMappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.class.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idEncounter.class.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. 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..0 | string | There are no (further) constraints on this element Element idEncounter.class.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.
|
| priority | 0..0 | 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. Indicates the urgency of the encounter. http://terminology.hl7.org/ValueSet/v3-ActPriority (example) Constraints
| |
| type | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.typeShort description Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) 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..*. A specific code indicating type of service provided
|
| serviceType | Σ | 1..1 | CodeableReference(HealthcareService) | Element idEncounter.serviceTypeShort description Service Speciality type DefinitionBroad categorization of the service that is to be provided (e.g. cardiology). CodeableReference(HealthcareService) BindingBroad categorization of the service that is to be provided.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.serviceType.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.serviceType.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| concept | Σ | 1..1 | CodeableConceptBinding | Element idEncounter.serviceType.conceptShort description Reference to a concept (by class) DefinitionA reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology. ServiceSpecialityValueSet (required) Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.serviceType.concept.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.serviceType.concept.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idEncounter.serviceType.concept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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..0 | id | There are no (further) constraints on this element Element idEncounter.serviceType.concept.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.serviceType.concept.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.serviceType.concept.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/service-specialityMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.serviceType.concept.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 | Σ C | 1..1 | code | Element idEncounter.serviceType.concept.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Physiotherapy 1Mappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.serviceType.concept.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idEncounter.serviceType.concept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. 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..0 | string | There are no (further) constraints on this element Element idEncounter.serviceType.concept.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.
|
| reference | Σ | 0..0 | Reference() | There are no (further) constraints on this element Element idEncounter.serviceType.referenceShort description Reference to a resource (by instance) DefinitionA reference to a resource the provides exact details about the information being referenced.
|
| subject | Σ | 1..1 | Reference(Patient) | Element idEncounter.subjectShort description The patient or group related to this encounter Alternate namespatient DefinitionThe patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam. While the encounter is always about the patient, the patient might 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).
|
| id | 0..1 | id | There are no (further) constraints on this element Element idEncounter.subject.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.subject.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.subject.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-2, ref-1 Constraints
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idEncounter.subject.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
|
| identifier | Σ C | 0..1 | Identifier | There are no (further) constraints on this element Element idEncounter.subject.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| display | Σ C | 0..1 | string | There are no (further) constraints on this element Element idEncounter.subject.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: ref-2 Constraints
|
| subjectStatus | 1..1 | CodeableConceptBinding | Element idEncounter.subjectStatusShort description event type Definitionthe type of this encounter within the patient's episode/case Different use-cases are likely to have different permitted transitions between states, such as an Emergency department could use Current status of the subject within the encounter.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.subjectStatus.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.subjectStatus.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idEncounter.subjectStatus.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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..0 | id | There are no (further) constraints on this element Element idEncounter.subjectStatus.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.subjectStatus.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.subjectStatus.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/event-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.subjectStatus.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 | Σ C | 1..1 | code | Element idEncounter.subjectStatus.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Admission encounter 1Discharge encounter 2Mappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.subjectStatus.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idEncounter.subjectStatus.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. 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..0 | string | There are no (further) constraints on this element Element idEncounter.subjectStatus.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.
|
| episodeOfCare | Σ | 0..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).
|
| basedOn | 0..0 | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | There are no (further) constraints on this element Element idEncounter.basedOnShort description The request that initiated this encounter Alternate namesincomingReferral DefinitionThe request this encounter satisfies (e.g. incoming referral or procedure request). Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) Constraints
| |
| careTeam | 0..0 | Reference(CareTeam) | There are no (further) constraints on this element Element idEncounter.careTeamShort description The group(s) that are allocated to participate in this encounter DefinitionThe group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.
| |
| partOf | 0..0 | Reference(Encounter) | 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.
| |
| serviceProvider | 1..1 | Reference(Organization) | There are no (further) constraints on this element Element idEncounter.serviceProviderShort description The organization (facility) responsible for this encounter DefinitionThe organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the colonoscopy example on the Encounter examples tab.
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.serviceProvider.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.serviceProvider.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idEncounter.serviceProvider.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-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | Element idEncounter.serviceProvider.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
OrganizationMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idEncounter.serviceProvider.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.serviceProvider.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.serviceProvider.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idEncounter.serviceProvider.identifier.useShort description usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.serviceProvider.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. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.serviceProvider.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/hci-codeExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.serviceProvider.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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idEncounter.serviceProvider.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idEncounter.serviceProvider.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 | Σ C | 0..0 | string | There are no (further) constraints on this element Element idEncounter.serviceProvider.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: ref-2 Constraints
|
| participant | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.participantShort description List of participants involved in the encounter DefinitionThe list of people responsible for providing the service. Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idEncounter.participant.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that 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 | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.participant.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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.
|
| type | Σ C | 1..1 | CodeableConceptBinding | Element idEncounter.participant.typeShort description Role of participant in encounter DefinitionRole of participant in encounter. The participant type indicates how an individual actor participates 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. EncounterParticipantTypeValueSet (required) ConditionsThe cardinality or value of this element may be affected by these constraints: enc-1, enc-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.participant.type.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.participant.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idEncounter.participant.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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..0 | id | There are no (further) constraints on this element Element idEncounter.participant.type.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.participant.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.participant.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
http://terminology.hl7.org/CodeSystem/v3-ParticipationTypeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.participant.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 | Σ C | 1..1 | code | Element idEncounter.participant.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Admitting clinician ADMAttending clinician ATNDMappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.participant.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idEncounter.participant.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. 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..0 | string | There are no (further) constraints on this element Element idEncounter.participant.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.
|
| period | 0..0 | 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.
| |
| actor | Σ C | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | There are no (further) constraints on this element Element idEncounter.participant.actorShort description The individual, device, or service participating in the encounter DefinitionPerson involved in the encounter, the patient/group is also included here to indicate that the patient was actually participating in the encounter. Not including the patient here covers use cases such as a case meeting between practitioners about a patient - non contact times. For planning purposes, Appointments may include a CareTeam participant to indicate that one specific person from the CareTeam will be assigned, but that assignment might not happen until the Encounter begins. Hence CareTeam is not included in Encounter.participant, as the specific individual should be assigned and represented as a Practitioner or other person resource. Similarly, Location can be included in Appointment.participant to assist with planning. However, the patient location is tracked on the Encounter in the Encounter.location property to allow for additional metadata and history to be recorded. The role of the participant can be used to declare what the actor will be doing in the scope of this encounter participation. If the individual is not specified during planning, then it is expected that the individual will be filled in at a later stage prior to the encounter commencing. Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) ConditionsThe cardinality or value of this element may be affected by these constraints: enc-1, enc-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.participant.actor.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.participant.actor.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idEncounter.participant.actor.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-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | Element idEncounter.participant.actor.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
PractitionerMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idEncounter.participant.actor.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.participant.actor.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.participant.actor.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idEncounter.participant.actor.identifier.useShort description usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.participant.actor.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. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.participant.actor.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/mcr-noExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.participant.actor.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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idEncounter.participant.actor.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idEncounter.participant.actor.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 | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.participant.actor.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: ref-2 Constraints
|
| appointment | Σ | 0..0 | 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.
|
| virtualService | 0..0 | VirtualServiceDetail | There are no (further) constraints on this element Element idEncounter.virtualServiceShort description Connection details of a virtual service (e.g. conference call) DefinitionConnection details of a virtual service (e.g. conference call). There are two types of virtual meetings that often exist:
Implementers may consider using Location.virtualService for persistent meeting rooms. If each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Encounter.participant BackboneElement.
| |
| actualPeriod | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.actualPeriodShort description The actual start and end time of the encounter DefinitionThe actual start and end time of the encounter. If not (yet) known, the end of the Period may be omitted.
| |
| id | 0..1 | id | There are no (further) constraints on this element Element idEncounter.actualPeriod.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.actualPeriod.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| start | Σ C | 1..1 | dateTime | There are no (further) constraints on this element Element idEncounter.actualPeriod.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: per-1 Constraints
|
| end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idEncounter.actualPeriod.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 no end was known or planned at the time the instance was created. 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 end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an 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 Constraints
|
| plannedStartDate | 0..0 | dateTime | There are no (further) constraints on this element Element idEncounter.plannedStartDateShort description The planned start date/time (or admission date) of the encounter DefinitionThe planned start date/time (or admission date) of the encounter.
| |
| plannedEndDate | 0..0 | dateTime | There are no (further) constraints on this element Element idEncounter.plannedEndDateShort description The planned end date/time (or discharge date) of the encounter DefinitionThe planned end date/time (or discharge date) of the encounter.
| |
| length | 0..0 | Duration | There are no (further) constraints on this element Element idEncounter.lengthShort description Actual quantity of time the encounter lasted (less time absent) DefinitionActual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values. If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval. May differ from the time in
| |
| reason | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.reasonShort description The list of medical reasons that are expected to be addressed during the episode of care DefinitionThe list of medical reasons that are expected to be addressed during the episode of care. The reason communicates what medical problem the patient has that should be addressed during the episode of care. This reason could be patient reported complaint, a clinical indication that was determined in a previous encounter or episode of care, or some planned care such as an immunization recommendation. In the case where you have a primary reason, but are expecting to also address other problems, you can list the primary reason with a use code of 'Chief Complaint', while the other problems being addressed would have a use code of 'Reason for Visit'. Examples:
|
| id | 0..0 | string | There are no (further) constraints on this element Element idEncounter.reason.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that 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 | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.reason.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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.
|
| use | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.reason.useShort description What the reason value should be used for/as DefinitionWhat the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening).
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.reason.use.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.reason.use.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idEncounter.reason.use.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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..0 | id | There are no (further) constraints on this element Element idEncounter.reason.use.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.reason.use.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idEncounter.reason.use.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idEncounter.reason.use.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 | Σ C | 1..1 | code | There are no (further) constraints on this element Element idEncounter.reason.use.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.reason.use.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idEncounter.reason.use.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. 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..0 | string | There are no (further) constraints on this element Element idEncounter.reason.use.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.
|
| value | Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure)Binding | There are no (further) constraints on this element Element idEncounter.reason.valueShort description Reason the encounter takes place (core or reference) Alternate namesIndication, Admission diagnosis DefinitionReason the encounter takes place, expressed as a code or a reference to another resource. For admissions, this can be used for a coded admission diagnosis. CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) BindingReason why the encounter takes place. EncounterReasonCodes (preferred) Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.reason.value.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.reason.value.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| concept | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.reason.value.conceptShort description Reference to a concept (by class) DefinitionA reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.
|
| reference | Σ | 0..1 | Reference() | There are no (further) constraints on this element Element idEncounter.reason.value.referenceShort description Reference to a resource (by instance) DefinitionA reference to a resource the provides exact details about the information being referenced.
|
| diagnosis | Σ | 0..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. Also note that for the purpose of billing, the diagnoses are recorded in the account where they can be ranked appropriately for how the invoicing/claiming documentation needs to be prepared.
|
| account | 0..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.
| |
| dietPreference | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.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.
| |
| specialArrangement | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.specialArrangementShort description Wheelchair, translator, stretcher, etc DefinitionAny special requests that have been made for this encounter, such as the provision of specific equipment or other things. Special arrangements. SpecialArrangements (preferred) Constraints
| |
| specialCourtesy | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.specialCourtesyShort description Special courtesies (VIP, board member) DefinitionSpecial courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy). Although the specialCourtesy property can contain values like VIP, the purpose of this field is intended to be used for flagging additional It could include things like the patient is to have a private room, special room features, receive a friendly visit from hospital adminisitration, or should be briefed on treatment by senior staff during the stay. It is not specifically intended to be used for securing the specific record - that is the purpose of the security meta tag, and where appropriate, both fields could be used. Special courtesies.
| |
| admission | 0..1 | BackboneElement | There are no (further) constraints on this element Element idEncounter.admissionShort description Details about the admission to a healthcare service DefinitionDetails about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge. 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 admission record.
| |
| id | 0..0 | string | There are no (further) constraints on this element Element idEncounter.admission.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.admission.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that 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 | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.admission.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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.
|
| preAdmissionIdentifier | 0..0 | Identifier | There are no (further) constraints on this element Element idEncounter.admission.preAdmissionIdentifierShort description Pre-admission identifier DefinitionPre-admission identifier.
| |
| origin | 0..0 | Reference(Location | Organization) | There are no (further) constraints on this element Element idEncounter.admission.originShort description The location/organization from which the patient came before admission DefinitionThe location/organization from which the patient came before admission. Reference(Location | Organization) Constraints
| |
| admitSource | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.admission.admitSourceShort description From where patient was admitted (physician referral, transfer) DefinitionFrom where patient was admitted (physician referral, transfer). From where the patient was admitted.
| |
| reAdmission | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.admission.reAdmissionShort description Indicates that the patient is being re-admitted DefinitionIndicates that this encounter is directly related to a prior admission, often because the conditions addressed in the prior admission were not fully addressed. The reason for re-admission of this admission encounter. http://terminology.hl7.org/ValueSet/v2-0092 (example) Constraints
| |
| destination | 0..1 | Reference(Organization) | Element idEncounter.admission.destinationShort description Location/organization to which the patient is discharged DefinitionLocation/organization to which the patient is discharged. Allowed aggregation:contained Constraints
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.admission.destination.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.admission.destination.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idEncounter.admission.destination.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-2, ref-1 Constraints
|
| type | Σ | 0..1 | uriBindingFixed Value | Element idEncounter.admission.destination.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
OrganizationMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idEncounter.admission.destination.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.admission.destination.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.admission.destination.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idEncounter.admission.destination.identifier.useShort description usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.admission.destination.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. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.admission.destination.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/hci-codeExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | Element idEncounter.admission.destination.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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456HCI Code 9KC00075Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idEncounter.admission.destination.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idEncounter.admission.destination.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 | Σ C | 1..1 | string | Element idEncounter.admission.destination.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: ref-2 Constraints
Organization name Changi ClinicMappings
|
| dischargeDisposition | 1..1 | CodeableConceptBinding | Element idEncounter.admission.dischargeDispositionShort description Category or kind of location after discharge DefinitionCategory or kind of location after discharge. Discharge Disposition. DischargeDispositionValueSet (required) Constraints
| |
| id | 0..0 | id | There are no (further) constraints on this element Element idEncounter.admission.dischargeDisposition.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.admission.dischargeDisposition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idEncounter.admission.dischargeDisposition.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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..0 | id | There are no (further) constraints on this element Element idEncounter.admission.dischargeDisposition.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.admission.dischargeDisposition.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idEncounter.admission.dischargeDisposition.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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/discharge-dispositionMappings
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idEncounter.admission.dischargeDisposition.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 | Σ C | 1..1 | code | Element idEncounter.admission.dischargeDisposition.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Followup at SOC 09Mappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idEncounter.admission.dischargeDisposition.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. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idEncounter.admission.dischargeDisposition.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. 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 | Element idEncounter.admission.dischargeDisposition.textShort description Description of the outcome or end state of the discharge for patient DefinitionDescription of the outcome or end state of the discharge for patient 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.
DischargeOutcome Patient has received treatment for broken hip and requires follow-up for physiotherapyMappings
|
| location | 1..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.locationShort description List of locations where the patient has been 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".
| |
| id | 0..0 | string | There are no (further) constraints on this element Element idEncounter.location.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that 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 | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idEncounter.location.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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.
|
| location | 1..1 | Reference(Location) | Element idEncounter.location.locationShort description Location the encounter takes place DefinitionThe location where the encounter takes place.
| |
| status | 0..0 | 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 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) Constraints
| |
| form | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.location.formShort description The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) DefinitionThis will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. Physical form of the location.
| |
| period | 0..0 | 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.
|
Terminologies
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| Encounter.language | required | http://hl7.org/fhir/ValueSet/all-languages|5.0.0 | IETF language tag for a human language |
| Encounter.identifier.use | required | http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 | Identifies the purpose for this identifier, if known . |
| Encounter.status | required | https://fhir.synapxe.sg/ValueSet/encounter-status | Current state of the encounter. |
| Encounter.class | required | https://fhir.synapxe.sg/ValueSet/patient-type | Classification of the encounter. |
| Encounter.serviceType | example | http://hl7.org/fhir/ValueSet/service-type | Broad categorization of the service that is to be provided. |
| Encounter.serviceType.concept | required | https://fhir.synapxe.sg/ValueSet/service-speciality | |
| Encounter.subject.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| Encounter.subjectStatus | required | https://fhir.synapxe.sg/ValueSet/event-type | Current status of the subject within the encounter. |
| Encounter.serviceProvider.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| Encounter.participant.type | required | https://fhir.synapxe.sg/ValueSet/encounter-participant-type | Role of participant in encounter. |
| Encounter.participant.actor.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| Encounter.reason.use | example | http://hl7.org/fhir/ValueSet/encounter-reason-use | |
| Encounter.reason.value | preferred | http://hl7.org/fhir/ValueSet/encounter-reason | Reason why the encounter takes place. |
| Encounter.diagnosis.condition | example | http://hl7.org/fhir/ValueSet/condition-code | |
| Encounter.diagnosis.use | preferred | http://hl7.org/fhir/ValueSet/encounter-diagnosis-use | The type of diagnosis this condition represents. |
| Encounter.admission.destination.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| Encounter.admission.dischargeDisposition | required | https://fhir.synapxe.sg/ValueSet/discharge-disposition | Discharge Disposition. |