3.51 StructureDefinition: PrescribeIT List - Allergies
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/profile-list-allergies
3.51.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from List
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 List | 0..* | lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-1: A list can only have an emptyReason if it is empty Definition: A set of information summarized from a list of other resources. Comments: Usage Note: This is where a patient's list of allergies can be identified. For the initial implementation this will be conveyed using text only. The remaining data elements required in this segment are supplied by fixed values. | |
 id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID |
| text | 1..1 | Narrative | Definition: A human-readable narrative that contains a summary of the resource, and may 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. |
  div | 1..1 | xhtml | Definition: The actual narrative content, a stripped down version of XHTML. Comments: Markup is prohibited - this must be a simple string providing a list of vertical-bar (|) separated allergies. For example: allergy1|allergy2|allergy3 Conformance Rule: Maximum character length set to ‘2000’. Note: Validator cannot enforce this so the rule is controlled through conformance. |
| status | 1..1 | code | Binding: ListStatus (required) Fixed Value: current Definition: Indicates the current state of this list. Comments: Fixed value: current |
| mode | 1..1 | code | Binding: ListMode (required) Fixed Value: snapshot Definition: How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Comments: Fixed value: snapshot |
| code | 1..1 | CodeableConcept | Binding: Example Use Codes for List (example) Definition: This code defines the purpose of the list - why it was created. Comments: For this codeable concept, 'coding' is mandatory and 'text' is not supported. Fixed values are defined for 'coding', refer to child elements. |
| coding | 1..* | Coding | Slice: Unordered, Open by value:system Definition: A reference to a code defined by a terminology system. 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 labelled as UserSelected = true. |
| coding (HL7Code) | 1..* | Coding | Definition: A reference to a code defined by a terminology system. 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 labelled as UserSelected = true. |
  system | 1..1 | uri | Fixed Value: http://hl7.org/fhir/list-example-use-codes Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: http://hl7.org/fhir/list-example-use-codes |
 code | 1..1 | code | Fixed Value: allergies 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). Comments: Fixed value: allergies |
| subject | 1..1 | Reference(Patient | Group | Device | Location) | Definition: The common subject (or patient) of the resources that are in the list, if there is one. Comments: |
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 List | S | 0..* | A simple allergy list expressed as a string | |
| id | S | 1..1 | id | |
| text | S | 1..1 | Narrative | |
| div | S | 1..1 | xhtml | |
| status | S | 1..1 | code | Fixed Value: current |
| mode | S | 1..1 | code | Fixed Value: snapshot |
| code | S | 1..1 | CodeableConcept | |
 coding | S | Coding | Slice: Unordered, Open by value:system | |
| coding | S | 1..* | Coding | |
| system | S | 1..1 | uri | Fixed Value: http://hl7.org/fhir/list-example-use-codes |
| code | S | 1..1 | code | Fixed Value: allergies |
| subject | S | 1..1 | Reference(Patient | Group | Device | Location) | Patient the allergy record is for |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | SI | 0..* | A simple allergy list expressed as a string | |
 id | SΣ | 1..1 | id | 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: http://tools.ietf.org/html/bcp47 (required) | |
| text | SI | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| status | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |
| div | S | 1..1 | xhtml | Limited xhtml content |
 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 | Business identifier | |
| status | ?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) Fixed Value: current |
| mode | ?!SΣ | 1..1 | code | working | snapshot | changes Binding: ListMode (required) Fixed Value: snapshot |
| title | Σ | 0..1 | string | Descriptive name for the list Example General': Dr. Jane's Patients |
| code | SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: Example Use Codes for List (example) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/list-example-use-codes |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: allergies |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
 subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Patient the allergy record is for |
| encounter | 0..1 | Reference(Encounter) | Context in which list created | |
| date | Σ | 0..1 | dateTime | When the list was prepared |
| source | Σ | 0..1 | Reference(Practitioner | Patient | Device) | Who and/or what defined the list contents (aka Author) |
| orderedBy | 0..1 | CodeableConcept | What order the list has Binding: List Order Codes (preferred) | |
| note | 0..* | Annotation | Comments about the list | |
| entry | I | 0..* | BackboneElement | Entries in the list |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| flag | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Patient Medicine Change Types (example) | |
| deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
| date | 0..1 | dateTime | When item added to list | |
| item | 1..1 | Reference(Resource) | Actual entry | |
| emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: List Empty Reasons (preferred) |
| Documentation for this format | ||||
Grid View
This structure is derived from List
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| List | 0..* | lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-1: A list can only have an emptyReason if it is empty Definition: A set of information summarized from a list of other resources. Comments: Usage Note: This is where a patient's list of allergies can be identified. For the initial implementation this will be conveyed using text only. The remaining data elements required in this segment are supplied by fixed values. | |
| id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID |
| text | 1..1 | Narrative | Definition: A human-readable narrative that contains a summary of the resource, and may 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. |
| div | 1..1 | xhtml | Definition: The actual narrative content, a stripped down version of XHTML. Comments: Markup is prohibited - this must be a simple string providing a list of vertical-bar (|) separated allergies. For example: allergy1|allergy2|allergy3 Conformance Rule: Maximum character length set to ‘2000’. Note: Validator cannot enforce this so the rule is controlled through conformance. |
| status | 1..1 | code | Binding: ListStatus (required) Fixed Value: current Definition: Indicates the current state of this list. Comments: Fixed value: current |
| mode | 1..1 | code | Binding: ListMode (required) Fixed Value: snapshot Definition: How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Comments: Fixed value: snapshot |
| code | 1..1 | CodeableConcept | Binding: Example Use Codes for List (example) Definition: This code defines the purpose of the list - why it was created. Comments: For this codeable concept, 'coding' is mandatory and 'text' is not supported. Fixed values are defined for 'coding', refer to child elements. |
| coding | 1..* | Coding | Slice: Unordered, Open by value:system Definition: A reference to a code defined by a terminology system. 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 labelled as UserSelected = true. |
| coding (HL7Code) | 1..* | Coding | Definition: A reference to a code defined by a terminology system. 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 labelled as UserSelected = true. |
| system | 1..1 | uri | Fixed Value: http://hl7.org/fhir/list-example-use-codes Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: http://hl7.org/fhir/list-example-use-codes |
| code | 1..1 | code | Fixed Value: allergies 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). Comments: Fixed value: allergies |
| subject | 1..1 | Reference(Patient | Group | Device | Location) | Definition: The common subject (or patient) of the resources that are in the list, if there is one. Comments: |
This structure is derived from List
Summary
Mandatory: 11 elements
Must-Support: 11 elements
Fixed Value: 4 elements
Slices
This structure defines the following Slices:
- The element List.code.coding is sliced based on the value of value:system
Differential View
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | S | 0..* | A simple allergy list expressed as a string | |
| id | S | 1..1 | id | |
| text | S | 1..1 | Narrative | |
| div | S | 1..1 | xhtml | |
| status | S | 1..1 | code | Fixed Value: current |
| mode | S | 1..1 | code | Fixed Value: snapshot |
| code | S | 1..1 | CodeableConcept | |
| coding | S | Coding | Slice: Unordered, Open by value:system | |
| coding | S | 1..* | Coding | |
| system | S | 1..1 | uri | Fixed Value: http://hl7.org/fhir/list-example-use-codes |
| code | S | 1..1 | code | Fixed Value: allergies |
| subject | S | 1..1 | Reference(Patient | Group | Device | Location) | Patient the allergy record is for |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | SI | 0..* | A simple allergy list expressed as a string | |
| id | SΣ | 1..1 | id | 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: http://tools.ietf.org/html/bcp47 (required) | |
| text | SI | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| status | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |
| div | S | 1..1 | xhtml | Limited xhtml content |
| 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 | Business identifier | |
| status | ?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) Fixed Value: current |
| mode | ?!SΣ | 1..1 | code | working | snapshot | changes Binding: ListMode (required) Fixed Value: snapshot |
| title | Σ | 0..1 | string | Descriptive name for the list Example General': Dr. Jane's Patients |
| code | SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: Example Use Codes for List (example) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/list-example-use-codes |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: allergies |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Patient the allergy record is for |
| encounter | 0..1 | Reference(Encounter) | Context in which list created | |
| date | Σ | 0..1 | dateTime | When the list was prepared |
| source | Σ | 0..1 | Reference(Practitioner | Patient | Device) | Who and/or what defined the list contents (aka Author) |
| orderedBy | 0..1 | CodeableConcept | What order the list has Binding: List Order Codes (preferred) | |
| note | 0..* | Annotation | Comments about the list | |
| entry | I | 0..* | BackboneElement | Entries in the list |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| flag | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Patient Medicine Change Types (example) | |
| deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
| date | 0..1 | dateTime | When item added to list | |
| item | 1..1 | Reference(Resource) | Actual entry | |
| emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: List Empty Reasons (preferred) |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.51.3 Terminology Bindings
Terminology Bindings
| Path | Name | Conformance | ValueSet |
| List.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| List.text.status | NarrativeStatus | required | NarrativeStatus |
| List.status | ListStatus | required | ListStatus |
| List.mode | ListMode | required | ListMode |
| List.code | Example Use Codes for List | example | Example Use Codes for List |
| List.orderedBy | List Order Codes | preferred | List Order Codes |
| List.entry.flag | Patient Medicine Change Types | example | Patient Medicine Change Types |
| List.emptyReason | List Empty Reasons | preferred | List Empty Reasons |
3.51.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| lst-2 | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-1 | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |