Nationella informationsmängder - Local Development build (v0.1). See the Directory of published versions
Resource Profile: Substans
| Defining URL: | https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/NIMSubstance |
| Version: | 0.1 |
| Name: | NIMSubstance |
| Title: | Substans |
| Status: | Active as of 2021-03-30T19:36:18+02:00 |
| Definition: | NIM substans används för att beskriva aktiva kemiska beståndsdelar av allergener, medel, ämnen, kemikalier, läkemedel och material. |
| Publisher: | Socialstyrelsen |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/NIMSubstance
NIM
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Substance
This structure is derived from Substance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Substance | 0..* | Substance | A homogeneous material with a definite composition | |
  category | 0..* | CodeableConcept | What class/type of substance this is | |
| code | S | 1..1 | CodeableConcept | What substance this is Binding: Substanser. (preferred) |
| description | S | 0..1 | string | Textual description of the substance, comments |
 instance | ||||
  quantity | S | 0..1 | SimpleQuantity | Amount of substance in the package |
 ingredient | ||||
 substance[x] | S | 1..1 | CodeableConcept, Reference(Substance) | A component of the substance |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Unique identifier |
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. |
| category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. |
| code | SΣ | 1..1 | CodeableConcept | What substance this is Binding: Substanser. (preferred) |
| description | SΣ | 0..1 | string | Textual description of the substance, comments |
| instance | Σ | 0..* | BackboneElement | If this describes a specific package/container of the substance |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier | Σ | 0..1 | Identifier | Identifier of the package/container |
| expiry | Σ | 0..1 | dateTime | When no longer valid to use |
| quantity | SΣ | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | Σ | 0..* | BackboneElement | Composition information about the substance |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| quantity | Σ | 0..1 | Ratio | Optional amount (concentration) |
 substance[x] | SΣ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |
| substanceCodeableConcept | CodeableConcept | |||
 substanceReference | Reference(Substance) | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
| code | Σ | 1..1 | CodeableConcept | What substance this is Binding: Substanser. (preferred) |
| description | Σ | 0..1 | string | Textual description of the substance, comments |
| instance | Σ | 0..* | BackboneElement | If this describes a specific package/container of the substance |
| quantity | Σ | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | Σ | 0..* | BackboneElement | Composition information about the substance |
| substance[x] | Σ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |
| substanceCodeableConcept | CodeableConcept | |||
| substanceReference | Reference(Substance) | |||
| Documentation for this format | ||||
This structure is derived from Substance
Differential View
This structure is derived from Substance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
| category | 0..* | CodeableConcept | What class/type of substance this is | |
| code | S | 1..1 | CodeableConcept | What substance this is Binding: Substanser. (preferred) |
| description | S | 0..1 | string | Textual description of the substance, comments |
| instance | ||||
| quantity | S | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | ||||
| substance[x] | S | 1..1 | CodeableConcept, Reference(Substance) | A component of the substance |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Unique identifier |
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. |
| category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. |
| code | SΣ | 1..1 | CodeableConcept | What substance this is Binding: Substanser. (preferred) |
| description | SΣ | 0..1 | string | Textual description of the substance, comments |
| instance | Σ | 0..* | BackboneElement | If this describes a specific package/container of the substance |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier | Σ | 0..1 | Identifier | Identifier of the package/container |
| expiry | Σ | 0..1 | dateTime | When no longer valid to use |
| quantity | SΣ | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | Σ | 0..* | BackboneElement | Composition information about the substance |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| quantity | Σ | 0..1 | Ratio | Optional amount (concentration) |
| substance[x] | SΣ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |
| substanceCodeableConcept | CodeableConcept | |||
| substanceReference | Reference(Substance) | |||
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| Substance.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.category | extensible | SubstanceCategoryCodes |
| Substance.code | preferred | SubstancesValueSet |
| Substance.ingredient.substance[x] | example | SubstanceCode |
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Substance | 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-4 | Substance | 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-5 | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Substance.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.instance | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.instance.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.instance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.instance.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.instance.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.instance.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.instance.expiry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.instance.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.ingredient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.ingredient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.ingredient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.ingredient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.ingredient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.ingredient.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.ingredient.substance[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |