PrescribeIT® Specification and Guide Version 5.0

 

The official URL for this profile is:

http://prescribeit.ca/fhir/StructureDefinition/profile-list-allergies

Download Excel representation

Description of Profiles, Differentials, Snapshots and how the different presentations work.

>

This structure is derived from List

NameCard.TypeConstraints and Usage
.  List 0..*Listlst-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..1idDefinition:
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 and is assigned by the sending application.

..  text 1..1NarrativeDefinition:
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.

...  status 1..1codeBinding: NarrativeStatus (required): The status of a resource narrative


Fixed Value: additional
Definition:
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.


Comments:
Fixed value: additional

...  div 1..1xhtmlDefinition:
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..1codeBinding: ListStatus (required): The current state of the list


Fixed Value: current
Definition:
Indicates the current state of this list.


Comments:
Fixed value: current

..  mode 1..1codeBinding: ListMode (required): The processing mode that applies to this list


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..1CodeableConceptBinding: Example Use Codes for List (example): What the purpose of a list is


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..*CodingSlice: 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..*CodingDefinition:
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..1uriFixed 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..1codeFixed 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..1Reference(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: 12 elements
Fixed Value: 5 elements

Slices

This structure defines the following Slices:

  • The element List.code.coding is sliced based on the value of value:system

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List S0..*ListA simple allergy list expressed as a string
... id S1..1idLogical id of this artifact
... text S1..1NarrativeText summary of the resource, for human interpretation
.... status S1..1codegenerated | extensions | additional | empty
Fixed Value: additional
.... div S1..1xhtmlLimited xhtml content
... status S1..1codecurrent | retired | entered-in-error
Fixed Value: current
... mode S1..1codeworking | snapshot | changes
Fixed Value: snapshot
... code S1..1CodeableConceptWhat the purpose of this list is
.... coding S1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:HL7Code S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/list-example-use-codes
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: allergies
... subject S1..1Reference(Patient | Group | Device | Location)Patient the allergy record is for

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. List SI0..*ListA simple allergy list expressed as a string
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text S1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative


Fixed Value: additional
.... div S1..1xhtmlLimited xhtml content
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required): The current state of the list


Fixed Value: current
... mode ?!SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list


Fixed Value: snapshot
... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code SΣ1..1CodeableConceptWhat the purpose of this list is
Binding: Example Use Codes for List (example): What the purpose of a list is

.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:HL7Code SΣ1..*CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/list-example-use-codes
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: allergies
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(Patient | Group | Device | Location)Patient the allergy record is for
... encounter 0..1Reference(Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ0..1Reference(Practitioner | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: List Order Codes (preferred): What order applies to the items in a list

... note 0..*AnnotationComments about the list
... entry I0..*BackboneElementEntries in the list
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: Patient Medicine Change Types (example): Codes that provide further information about the reason and meaning of the item in the list

.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(Resource)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: List Empty Reasons (preferred): If a list is empty, why it is empty


doco Documentation for this format

Grid View

This structure is derived from List

NameCard.TypeConstraints and Usage
.  List 0..*Listlst-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..1idDefinition:
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 and is assigned by the sending application.

..  text 1..1NarrativeDefinition:
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.

...  status 1..1codeBinding: NarrativeStatus (required): The status of a resource narrative


Fixed Value: additional
Definition:
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.


Comments:
Fixed value: additional

...  div 1..1xhtmlDefinition:
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..1codeBinding: ListStatus (required): The current state of the list


Fixed Value: current
Definition:
Indicates the current state of this list.


Comments:
Fixed value: current

..  mode 1..1codeBinding: ListMode (required): The processing mode that applies to this list


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..1CodeableConceptBinding: Example Use Codes for List (example): What the purpose of a list is


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..*CodingSlice: 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..*CodingDefinition:
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..1uriFixed 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..1codeFixed 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..1Reference(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: 12 elements
Fixed Value: 5 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. List S0..*ListA simple allergy list expressed as a string
... id S1..1idLogical id of this artifact
... text S1..1NarrativeText summary of the resource, for human interpretation
.... status S1..1codegenerated | extensions | additional | empty
Fixed Value: additional
.... div S1..1xhtmlLimited xhtml content
... status S1..1codecurrent | retired | entered-in-error
Fixed Value: current
... mode S1..1codeworking | snapshot | changes
Fixed Value: snapshot
... code S1..1CodeableConceptWhat the purpose of this list is
.... coding S1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:HL7Code S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/list-example-use-codes
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: allergies
... subject S1..1Reference(Patient | Group | Device | Location)Patient the allergy record is for

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List SI0..*ListA simple allergy list expressed as a string
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text S1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative


Fixed Value: additional
.... div S1..1xhtmlLimited xhtml content
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required): The current state of the list


Fixed Value: current
... mode ?!SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list


Fixed Value: snapshot
... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code SΣ1..1CodeableConceptWhat the purpose of this list is
Binding: Example Use Codes for List (example): What the purpose of a list is

.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:HL7Code SΣ1..*CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/list-example-use-codes
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: allergies
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(Patient | Group | Device | Location)Patient the allergy record is for
... encounter 0..1Reference(Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ0..1Reference(Practitioner | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: List Order Codes (preferred): What order applies to the items in a list

... note 0..*AnnotationComments about the list
... entry I0..*BackboneElementEntries in the list
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: Patient Medicine Change Types (example): Codes that provide further information about the reason and meaning of the item in the list

.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(Resource)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: List Empty Reasons (preferred): If a list is empty, why it is empty


doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
List.languagerequiredhttp://tools.ietf.org/html/bcp47
List.text.statusrequiredFixed Value: additional
List.statusrequiredFixed Value: current
List.moderequiredFixed Value: snapshot
List.codeexampleExample Use Codes for List
List.orderedBypreferredList Order Codes
List.entry.flagexamplePatient Medicine Change Types
List.emptyReasonpreferredList Empty Reasons

Constraints

IdPathDetailsRequirements
lst-2ListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-1ListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()