| Basic | I | | Basic | Element idShort description Information showing that the target resource has an privacy (sv integritet) or confidenitiality (sv sekretess) lock Alternate names Z-resource, Extension-resource, Custom-resource Definition As described in "Lag (2018:1212) om nationell läkemedelslista" chapter 4, it must be possible for a patient or practitioner to lock parts of a prescription. An active DataLock referencing a resource shows that parts of, or the full resource, should be filtered based on who/what tries to access the information. The filtering is done by the Swedish eHealth Agency, given which role tries to acess the resource (target of the DataLock) and purpose of the access. Creating or in-activating a DataLock is done by the client.
Basic Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
- rim: Entity. Role, or Act
- rim: Act, Entity or Role
|
| id | S Σ | 0..1 | string | Element idShort description Logical id of this artifact Definition The 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.
This id is identified by the URI http://electronichealth.se/identifier/nlldatalockid in documentation and external systems.
string Mappings |
| meta | S Σ | 0..1 | Meta | There are no (further) constraints on this element Element idShort description Metadata about the resource Definition The 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.
Meta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May 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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| versionId | S Σ | 0..1 | id | Element idShort description Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
id Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- EHM: Spärrversion
|
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idShort description When the resource version last changed Definition When the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
instant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idShort description Identifies where the resource comes from Definition A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.
This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idShort description Profiles this resource claims to conform to Definition Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
canonical(StructureDefinition) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idShort description Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding Binding Security Labels from the Healthcare Privacy and Security Classification System.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idShort description Tags applied to this resource Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idShort description A set of rules under which this content was created Definition A 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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description Language of the resource content Definition The 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).
code Binding CommonLanguages (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| text | | 0..1 | Narrative | There are no (further) constraints on this element Element idShort description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A 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.
Narrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idShort description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These 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.
Resource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | I | 3..* | Extension | Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May 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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| nllTargetPatient | S I | 0..1 | Extension(Reference(NLLPatient)) | Element idBasic.extension:nllTargetPatient Reference to patient affected by this lock Alternate names extensions, user content Definition Reference to the patient whos processesing of personal data is affected by the lock.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension(Reference(NLLPatient)) Extension URL http://electronichealth.se/fhir/StructureDefinition/NLLDataLockTarget Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
- rim: n/a
- rim: N/A
- EHM: Referens till patient
|
| nllPrescriptionChain | S I | 0..1 | Extension(uuid) | Element idBasic.extension:nllPrescriptionChain Prescription chain id Alternate names extensions, user content Definition Prescription chain id that is locked. All MedicationRequests and MedicationDispenses in the prescription chain are locked.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that 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(uuid) Extension URL http://electronichealth.se/fhir/StructureDefinition/NLLPrescriptionChain Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
- rim: n/a
- rim: N/A
- EHM: Förskrivningskedje-id
|
| nllLockedSubjectType | S I | 1..1 | Extension(code)Binding | Element idBasic.extension:nllLockedSubjectType Type of information locked Alternate names extensions, user content Definition Type of information locked by the presence of the data lock. The locked information is all treatment reasons (sv: behandlingsorsak) for a confidentiality lock with the type SEKRETESS_PAT. Otherwise it is either a complete prescription chain (sv förskrivningskedja) or all dispenses for paper prescriptions (sv: pappersuttag) for the referenced patient.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that 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(code) Extension URL http://electronichealth.se/fhir/StructureDefinition/NLLLockedSubjectType Binding Spärrad uppgift (locked-subjects) (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
- rim: n/a
- rim: N/A
- EHM: Spärrad uppgift
|
| nllStatus | S I | 1..1 | Extension(code) | Element idBasic.extension:nllStatus The status of the lock, reflects if it is active or not Alternate names extensions, user content Definition The status of the lock, reflects if it is active or not
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that 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(code) Extension URL http://electronichealth.se/fhir/StructureDefinition/NLLDataLockStatus Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
- rim: n/a
- rim: N/A
- EHM: Spärrstatus
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idBasic.extension:nllStatus.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.extension:nllStatus.extension Additional content defined by implementations Alternate names extensions, user content Definition May 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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idBasic.extension:nllStatus.url identifies the meaning of the extension Definition Source 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.
uri Fixed value http://electronichealth.se/fhir/StructureDefinition/NLLDataLockStatus |
| value[x] | | 1..1 | Binding | Element idBasic.extension:nllStatus.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Spärrstatus (data-lock-status) (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueCode | | | code | There are no (further) constraints on this element Data type code |
| nllLegalGround | S I | 1..1 | Extension(code)Binding | Element idBasic.extension:nllLegalGround Legal ground for the data lock Alternate names extensions, user content Definition The legal ground defines who the lock applies to and the legal ground for setting the data lock. <br>
An privacy lock (INTEGRITET) affects the purpose "health care" (sv "vård") for health care pracititioners and the purpose "support patient medication use" (sv "underlättande av patients läkemedelsanvändning") for pharmacy personnel.<br>
A confidentiality lock applies to the patient (SEKRETESS_PAT) or the patient's guardian (SEKRETESS_VH). The confidentiality lock is based on a confidentiality assessment according to the law "Public Access to Information and Secrecy Act" (sv Offentlighets- och sekretesslag).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that 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(code) Extension URL http://electronichealth.se/fhir/StructureDefinition/NLLDataLockLegalGround Binding Spärrtyp (data-lock-types) (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
- rim: n/a
- rim: N/A
- EHM: Spärrorsak
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Extensions that cannot be ignored Alternate names extensions, user content Definition May 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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idShort description Business identifier Definition Identifier assigned to the resource for business purposes, outside the context of FHIR.
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- w5: FiveWs.identifier
- rim: ./identifier
|
| code | S Σ ?! | 1..1 | CodeableConceptBinding | Element idShort description Resource type: Data Lock (sv. Spärr) Definition The type of resource is "Data Lock" (sv. Spärr)
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.
CodeableConcept Binding Codes for identifying types of Basic
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.what[x]
- rim: ./code
- EHM: Resurstyp Spärr
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May 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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| coding | S Σ | 1..1 | Coding | There are no (further) constraints on this element Element idShort description Code defined by a terminology system Definition A 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.
Coding Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBasic.code.coding.extension Additional content defined by implementations Alternate names extensions, user content Definition May 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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| system | S Σ | 0..1 | uriFixed Value | Element idShort description Identity of the terminology system Definition The 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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
http://ehalsomyndigheten.se/fhir/CodeSystem/basic-resource-types - rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
| version | S Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.code.coding.version Version of the system - if relevant Definition The 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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | codeFixed Value | Element idShort description Symbol in syntax defined by the system Definition A 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
code Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idBasic.code.coding.display Representation defined by the system Definition A 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
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| 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 Definition Indicates 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.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idShort description Plain text representation of the concept Definition A 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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| subject | Σ I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idShort description Identifies the focus of this resource Definition Identifies 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.
Reference(Resource) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5: FiveWs.subject[x]
- rim: ./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)
- w5: FiveWs.subject
|
| created | Σ | 0..1 | date | There are no (further) constraints on this element Element idShort description When created Definition Identifies when the resource was first created.
Allows ordering resource instances by time.
date Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- w5: FiveWs.recorded
- rim: ./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)
|
| author | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idShort description Who created Definition Indicates 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- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5: FiveWs.author
- rim: ./participation[typeCode='SUB'] (possibly through a ControlAct and Role)
|