sfm-Interaction
Profile on Interaction used for SFM.
Only bundled within the sfm-lib-List (warnings) in v1.0 of SFM.
Profile
SfmInteraction (Basic) | I | Basic | There are no (further) constraints on this element Element idBasic Resource for non-supported content Alternate namesZ-resource, Extension-resource, Custom-resource DefinitionBasic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idBasic.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idBasic.meta 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 idBasic.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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 it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idBasic.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idBasic.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and 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 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idBasic.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | Element idBasic.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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
|
interacationdata | S I | 0..* | Extension(Complex) | Element idBasic.extension:interacationdata Interactiondata Alternate namesextensions, user content DefinitionInteractiondata based on information from FEST. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttp://ehelse.no/fhir/StructureDefinition/sfm-interactiondata Constraints
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.id 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.
| ||
extension | I | 4..* | Extension | Element idBasic.extension:interacationdata.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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
|
relevance | S I | 1..1 | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance Relevance of interaction Alternate namesextensions, user content DefinitionCoded values that identifies how critical the interaction is. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. relevance
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].coding 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..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].coding.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 | Σ | 0..1 | uriFixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].coding.system 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 reference to some definition that establishes the system clearly and unambiguously.
urn:oid:2.16.578.1.12.4.1.1.7483
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].coding.version 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 | Σ | 0..1 | code | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].coding.userSelected 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..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:relevance.value[x].text 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.
|
situationcriterium | S I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:situationcriterium Describes when the warning is relevant Alternate namesextensions, user content DefinitionTextual description telling when interaction is relevant. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:situationcriterium.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:situationcriterium.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:situationcriterium.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. situationcriterium
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:situationcriterium.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
clinicalconsequence | S I | 1..1 | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:clinicalconsequence Conseques of not taking action Alternate namesextensions, user content DefinitionDescribes what actions should be taken and consequeses of not taking action. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:clinicalconsequence.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:clinicalconsequence.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:clinicalconsequence.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. clinicalconsequence
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:clinicalconsequence.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
interactionmechanism | S I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:interactionmechanism What leads to interaction Alternate namesextensions, user content DefinitionDescribes what are the mechanisms that lead to interaction. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:interactionmechanism.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:interactionmechanism.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:interactionmechanism.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. interactionmechanism
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:interactionmechanism.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
source | S I | 1..1 | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source Source used to identify interaction Alternate namesextensions, user content DefinitionWhat source that docuements the interaction problem. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. source
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].coding 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..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].coding.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 | Σ | 0..1 | uriFixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].coding.system 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 reference to some definition that establishes the system clearly and unambiguously.
urn:oid:2.16.578.1.12.4.1.1.7485
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].coding.version 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 | Σ | 0..1 | code | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].coding.userSelected 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..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:source.value[x].text 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.
|
handling | S I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:handling Actions that should be taken Alternate namesextensions, user content DefinitionDescribes how to handle the interaction. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:handling.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:handling.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:handling.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. handling
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:handling.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
displayrule | S I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule Rule for showing to user Alternate namesextensions, user content DefinitionIdentifes when to present to user and what kind of user. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. displayrule
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].coding 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..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].coding.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 | Σ | 0..1 | uriFixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].coding.system 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 reference to some definition that establishes the system clearly and unambiguously.
urn:oid:2.16.578.1.12.4.1.1.7442
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].coding.version 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 | Σ | 0..1 | code | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].coding.userSelected 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..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:displayrule.value[x].text 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 | S I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference References to background information Alternate namesextensions, user content DefinitionReferences to documentation of the interaction. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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
|
source | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:source Additional content defined 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:source.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:source.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:source.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. source
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:source.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
link | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:link Additional content defined 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:link.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:link.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:link.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. link
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.extension:link.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueUrl | url | There are no (further) constraints on this element Data type | ||
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. reference
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:reference.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
substancegroup | S I | 1..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup identifies substances that interact Alternate namesextensions, user content Definitionsubstances that are identified to interact. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.id 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.
| ||
extension | I | 1..* | Extension | Element idBasic.extension:interacationdata.extension:substancegroup.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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
|
name | S I | 0..1 | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:name Additional content defined 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:name.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:name.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:name.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. name
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:name.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
substance | S I | 1..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance Additional content defined 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.id 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.
| ||
extension | I | 1..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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
|
atc | I | 0..1 | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc Additional content defined 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. atc
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].coding 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..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].coding.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 | Σ | 0..1 | uriFixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].coding.system 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 reference to some definition that establishes the system clearly and unambiguously.
urn:oid:2.16.578.1.12.4.1.1.7180
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].coding.version 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 | Σ | 0..1 | code | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].coding.userSelected 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..1 | string | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:atc.value[x].text 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.
|
substance | I | 1..1 | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:substance Additional content defined 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:substance.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:substance.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:substance.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. substance
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:substance.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
refsubstance | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:refsubstance Additional content defined 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:refsubstance.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:refsubstance.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:refsubstance.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. refsubstance
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.extension:refsubstance.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueReference | Reference() | There are no (further) constraints on this element Data type | ||
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. substance
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.extension:substance.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. substancegroup
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.extension:substancegroup.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
url | 1..1 | Fixed Value | There are no (further) constraints on this element Element idBasic.extension:interacationdata.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://ehelse.no/fhir/StructureDefinition/sfm-interactiondata
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idBasic.extension:interacationdata.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idBasic.identifier Business identifier DefinitionIdentifier assigned to the resource for business purposes, outside the context of FHIR.
|
code | S Σ ?! | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idBasic.code Kind of Resource DefinitionIdentifies the 'type' of resource - equivalent to the resource name for other resources. Must be able to distinguish different types of Basic resources. Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored. Codes for identifying types of resources not yet defined by FHIR.
|
id | 0..1 | There are no (further) constraints on this element Element idBasic.code.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.code.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idBasic.code.coding 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..1 | There are no (further) constraints on this element Element idBasic.code.coding.id 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.
| ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.code.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the 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 idBasic.code.coding.system 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 reference to some definition that establishes the system clearly and unambiguously.
http://ehelse.no/fhir/CodeSystem/FEST
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.code.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idBasic.code.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idBasic.code.coding.userSelected 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..1 | string | There are no (further) constraints on this element Element idBasic.code.text 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.
|
subject | Σ I | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idBasic.subject Identifies the focus of this resource DefinitionIdentifies the patient, practitioner, device or any other resource that is the "focus" of this resource. Needed for partitioning the resource by Patient. Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.
|
created | S Σ | 0..1 | date | There are no (further) constraints on this element Element idBasic.created When created DefinitionIdentifies when the resource was first created. Allows ordering resource instances by time.
|
author | Σ I | 0..0 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idBasic.author Who created DefinitionIndicates who was responsible for creating the resource instance. Needed for partitioning the resource. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) Constraints
|