Skip to content

Source Value Record Profile

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-core-source-value-record
Statusdraft · 1.33.0
BaseBasic (constraint)
SourceFSH · JSON

Source values that have no record of their own to sit on: a whole source category this guide does not model, or a value with no resource to carry it. One per patient per source category, coded under the source's namespace, with the values in the nexus-source-value extension. Nothing computes on it. First pass.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

Basic

Short Source values with no record of their own
Definition Source values that have no record to sit on: a whole category of source data this guide does not model, or a value about the patient that no resource here carries. The values are in the nexus-source-value extension, exactly as the source held them. One per patient per source category.
Cardinality 0..*
Invariants dom-2, dom-3, dom-4, dom-5, dom-6, nexus-source-value-record-category
Also called Z-resource, Extension-resource, Custom-resource

Basic.id

Short 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.
Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Basic.meta

Short 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.
Cardinality 0..1
Type Meta
Invariants ele-1

Basic.implicitRules

Short 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.
Comments 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.
Cardinality 0..1
Type uri
Modifier yes — This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Invariants ele-1

Basic.language

Short Language of the resource content
Definition The base language in which the resource is written.
Comments 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).
Cardinality 0..1
Type code
Binding languages (preferred)
Invariants ele-1

Basic.text

Short Text summary of the resource, for human interpretation
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.
Comments 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.
Cardinality 0..1
Type Narrative
Invariants ele-1
Also called narrative, html, xhtml, display

Basic.contained

Short Contained, inline 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.
Comments 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.
Cardinality 0..*
Type Resource
Also called inline resources, anonymous resources, contained resources

Basic.extension

Short Additional content defined by implementations
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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 1..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Basic.extension:sourceValue

Short The category's values, one child per source field
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.
Comments Each child url is https://fhir.apps.health/source-field/<source>/<field>, under the same <source> as code.
Cardinality 1..1
Type Extension(Source Value Extension)
Must Support yes
Invariants ele-1, ext-1
Also called extensions, user content

Basic.modifierExtension

Short Extensions that cannot be ignored
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).
Requirements 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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Invariants ele-1, ext-1
Also called extensions, user content

Basic.identifier

Short Business identifier
Definition Identifier assigned to the resource for business purposes, outside the context of FHIR.
Cardinality 0..*
Type Identifier
Invariants ele-1

Basic.code

Short The source category
Definition Identifies the 'type' of resource - equivalent to the resource name for other resources.
Requirements Must be able to distinguish different types of Basic resources.
Comments system is https://fhir.apps.health/source-field/<source> (invariant nexus-source-value-record-category); code is the source's own name for the category. Not a published code system: never expanded, never validated against a terminology service.
Cardinality 1..1
Type CodeableConcept
Must Support yes
Modifier yes — This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
Binding basic-resource-type (example)
Invariants ele-1

Basic.code.id

Short 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.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Basic.code.extension

Short Additional content defined by implementations
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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Basic.code.coding

Short Code defined by a terminology system
Definition A reference to a code defined by a terminology system.
Requirements Allows for alternative encodings within a code system, and translations to other code systems.
Comments 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.
Cardinality 1..1
Type Coding
Must Support yes
Invariants ele-1

Basic.code.coding.id

Short 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.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Basic.code.coding.extension

Short Additional content defined by implementations
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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Basic.code.coding.system

Short Identity of the terminology system
Definition The identification of the code system that defines the meaning of the symbol in the code.
Requirements Need to be unambiguous about the source of the definition of the symbol.
Comments 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.
Cardinality 1..1
Type uri
Must Support yes
Invariants ele-1

Basic.code.coding.version

Short 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.
Comments 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.
Cardinality 0..1
Type string
Invariants ele-1

Basic.code.coding.code

Short 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).
Requirements Need to refer to a particular code in the system.
Cardinality 1..1
Type code
Must Support yes
Invariants ele-1

Basic.code.coding.display

Short Representation defined by the system
Definition A representation of the meaning of the code in the system, following the rules of the system.
Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Cardinality 0..1
Type string
Invariants ele-1

Basic.code.coding.userSelected

Short 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).
Requirements 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.
Comments 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.
Cardinality 0..1
Type boolean
Invariants ele-1

Basic.code.text

Short 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.
Requirements 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.
Comments Very often the text is the same as a displayName of one of the codings.
Cardinality 0..1
Type string
Invariants ele-1

Basic.subject

Short The patient the values are about
Definition Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
Requirements Needed for partitioning the resource by Patient.
Comments Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.
Cardinality 1..1
Type Reference(Patient Profile)
Must Support yes
Invariants ele-1

Basic.created

Short When the values were recorded here
Definition Identifies when the resource was first created.
Requirements Allows ordering resource instances by time.
Comments For an import, when the import wrote this record. The import's Provenance names the file, the importer and the time.
Cardinality 1..1
Type date
Must Support yes
Invariants ele-1

Basic.author

Short Who created
Definition Indicates who was responsible for creating the resource instance.
Requirements Needed for partitioning the resource.
Cardinality 0..1
Type Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
Invariants ele-1