Botswana FHIR Implementation Guide
1.0.0 - ci-build Botswana flag

Botswana FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/botswana-hie-fhir-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Requirements

Official URL: http://moh.bw.org/StructureDefinition/bw-requirements Version: 1.0.0
Active as of 2025-08-20 Computable Name: BwRequirements

Represents the requirements for the use case described in this Implementation Guide.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RequirementsType 1..* CodeableConcept Requirements Type
URL: http://moh.bw.org/StructureDefinition/requirements-type
Binding: Requirements Type Codes (required)
... name ΣC 1..1 string Name for this Requirements (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... Slices for actor S 1..* canonical(ActorDefinition) Actor for these requirements
Slice: Unordered, Open by value:extension.value
.... actor:Primary S 1..* canonical(ActorDefinition) Actor for these requirements
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... extension 0..0
....... url 1..1 uri "http://moh.bw.org/StructureDefinition/actor-classification"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Actor Classification Codes (required)
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: primary
......... 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
.... actor:Secondary S 0..* canonical(ActorDefinition) Actor for these requirements
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... extension 0..0
....... url 1..1 uri "http://moh.bw.org/StructureDefinition/actor-classification"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Actor Classification Codes (required)
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: secondary
......... 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
... statement 1..* BackboneElement Actual statement as markdown
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... key 1..1 id Key that identifies this statement
.... requirement 1..1 markdown The actual requirement

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Requirements.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
Requirements.actor:Primary.extension:ActorClassification.value[x]requiredPattern Value: primary
http://moh.bw.org/ValueSet/vs-actor-classification-codes
From this IG
Requirements.actor:Secondary.extension:ActorClassification.value[x]requiredPattern Value: secondary
http://moh.bw.org/ValueSet/vs-actor-classification-codes
From this IG

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningRequirementsName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Requirements

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements 0..* Requirements A set of requirements - features of systems that are necessary
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RequirementsType 1..* CodeableConcept Requirements Type
URL: http://moh.bw.org/StructureDefinition/requirements-type
Binding: Requirements Type Codes (required)
... name 1..1 string Name for this Requirements (computer friendly)
... Slices for actor S 1..* canonical(ActorDefinition) Actor for these requirements
Slice: Unordered, Open by value:extension.value
.... actor:Primary S 1..* canonical(ActorDefinition) Actor for these requirements
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... value[x] 1..1 CodeableConcept Value of extension
Required Pattern: At least the following
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: primary
.... actor:Secondary S 0..* canonical(ActorDefinition) Actor for these requirements
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... value[x] 1..1 CodeableConcept Value of extension
Required Pattern: At least the following
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: secondary

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: cnl-0
... id Σ 0..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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RequirementsType 1..* CodeableConcept Requirements Type
URL: http://moh.bw.org/StructureDefinition/requirements-type
Binding: Requirements Type Codes (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this Requirements, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the Requirements (business identifier)
... version Σ 0..1 string Business version of the Requirements
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this Requirements (computer friendly)
... title Σ 0..1 string Name for this Requirements (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the requirements
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for Requirements (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this Requirements is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... derivedFrom Σ 0..* canonical(Requirements) Other set of Requirements this builds on
... reference 0..* url External artifact (rule/document etc. that) created this set of requirements
... Slices for actor S 1..* canonical(ActorDefinition) Actor for these requirements
Slice: Unordered, Open by value:extension.value
.... actor:Primary S 1..* canonical(ActorDefinition) Actor for these requirements
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://moh.bw.org/StructureDefinition/actor-classification"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Actor Classification Codes (required)
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: primary
......... 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
..... value 0..1 canonical Primitive value for canonical
.... actor:Secondary S 0..* canonical(ActorDefinition) Actor for these requirements
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://moh.bw.org/StructureDefinition/actor-classification"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Actor Classification Codes (required)
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: secondary
......... 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
..... value 0..1 canonical Primitive value for canonical
... statement 1..* BackboneElement Actual statement as markdown
.... 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
.... key 1..1 id Key that identifies this statement
.... label 0..1 string Short Human label for this statement
.... conformance 0..* code SHALL | SHOULD | MAY | SHOULD-NOT
Binding: ConformanceExpectation (required)
.... conditionality 0..1 boolean Set to true if requirements statement is conditional
.... requirement 1..1 markdown The actual requirement
.... derivedFrom 0..1 string Another statement this clarifies/restricts ([url#]key)
.... parent 0..1 string A larger requirement that this requirement helps to refine and enable
.... satisfiedBy 0..* url Design artifact that satisfies this requirement
.... reference 0..* url External artifact (rule/document etc. that) created this requirement
.... source 0..* Reference(CareTeam | Device | Group | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who asked for this statement

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Requirements.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Requirements.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
From the FHIR Standard
Requirements.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
Requirements.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
Requirements.actor:Primary.extension:ActorClassification.value[x]requiredPattern Value: primary
http://moh.bw.org/ValueSet/vs-actor-classification-codes
From this IG
Requirements.actor:Secondary.extension:ActorClassification.value[x]requiredPattern Value: secondary
http://moh.bw.org/ValueSet/vs-actor-classification-codes
From this IG
Requirements.statement.conformancerequiredConformanceExpectation
http://hl7.org/fhir/ValueSet/conformance-expectation|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningRequirementsName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningRequirements.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Requirements

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Requirements.actor

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RequirementsType 1..* CodeableConcept Requirements Type
URL: http://moh.bw.org/StructureDefinition/requirements-type
Binding: Requirements Type Codes (required)
... name ΣC 1..1 string Name for this Requirements (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... Slices for actor S 1..* canonical(ActorDefinition) Actor for these requirements
Slice: Unordered, Open by value:extension.value
.... actor:Primary S 1..* canonical(ActorDefinition) Actor for these requirements
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... extension 0..0
....... url 1..1 uri "http://moh.bw.org/StructureDefinition/actor-classification"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Actor Classification Codes (required)
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: primary
......... 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
.... actor:Secondary S 0..* canonical(ActorDefinition) Actor for these requirements
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... extension 0..0
....... url 1..1 uri "http://moh.bw.org/StructureDefinition/actor-classification"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Actor Classification Codes (required)
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: secondary
......... 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
... statement 1..* BackboneElement Actual statement as markdown
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... key 1..1 id Key that identifies this statement
.... requirement 1..1 markdown The actual requirement

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Requirements.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
Requirements.actor:Primary.extension:ActorClassification.value[x]requiredPattern Value: primary
http://moh.bw.org/ValueSet/vs-actor-classification-codes
From this IG
Requirements.actor:Secondary.extension:ActorClassification.value[x]requiredPattern Value: secondary
http://moh.bw.org/ValueSet/vs-actor-classification-codes
From this IG

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningRequirementsName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Requirements

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements 0..* Requirements A set of requirements - features of systems that are necessary
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RequirementsType 1..* CodeableConcept Requirements Type
URL: http://moh.bw.org/StructureDefinition/requirements-type
Binding: Requirements Type Codes (required)
... name 1..1 string Name for this Requirements (computer friendly)
... Slices for actor S 1..* canonical(ActorDefinition) Actor for these requirements
Slice: Unordered, Open by value:extension.value
.... actor:Primary S 1..* canonical(ActorDefinition) Actor for these requirements
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... value[x] 1..1 CodeableConcept Value of extension
Required Pattern: At least the following
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: primary
.... actor:Secondary S 0..* canonical(ActorDefinition) Actor for these requirements
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... value[x] 1..1 CodeableConcept Value of extension
Required Pattern: At least the following
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: secondary

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: cnl-0
... id Σ 0..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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RequirementsType 1..* CodeableConcept Requirements Type
URL: http://moh.bw.org/StructureDefinition/requirements-type
Binding: Requirements Type Codes (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this Requirements, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the Requirements (business identifier)
... version Σ 0..1 string Business version of the Requirements
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this Requirements (computer friendly)
... title Σ 0..1 string Name for this Requirements (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the requirements
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for Requirements (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this Requirements is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... derivedFrom Σ 0..* canonical(Requirements) Other set of Requirements this builds on
... reference 0..* url External artifact (rule/document etc. that) created this set of requirements
... Slices for actor S 1..* canonical(ActorDefinition) Actor for these requirements
Slice: Unordered, Open by value:extension.value
.... actor:Primary S 1..* canonical(ActorDefinition) Actor for these requirements
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://moh.bw.org/StructureDefinition/actor-classification"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Actor Classification Codes (required)
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: primary
......... 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
..... value 0..1 canonical Primitive value for canonical
.... actor:Secondary S 0..* canonical(ActorDefinition) Actor for these requirements
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ActorClassification 1..1 (Complex) Actor Classification
URL: http://moh.bw.org/StructureDefinition/actor-classification
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://moh.bw.org/StructureDefinition/actor-classification"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Actor Classification Codes (required)
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://moh.bw.org/CodeSystem/cs-actor-classification-codes
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: secondary
......... 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
..... value 0..1 canonical Primitive value for canonical
... statement 1..* BackboneElement Actual statement as markdown
.... 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
.... key 1..1 id Key that identifies this statement
.... label 0..1 string Short Human label for this statement
.... conformance 0..* code SHALL | SHOULD | MAY | SHOULD-NOT
Binding: ConformanceExpectation (required)
.... conditionality 0..1 boolean Set to true if requirements statement is conditional
.... requirement 1..1 markdown The actual requirement
.... derivedFrom 0..1 string Another statement this clarifies/restricts ([url#]key)
.... parent 0..1 string A larger requirement that this requirement helps to refine and enable
.... satisfiedBy 0..* url Design artifact that satisfies this requirement
.... reference 0..* url External artifact (rule/document etc. that) created this requirement
.... source 0..* Reference(CareTeam | Device | Group | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who asked for this statement

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Requirements.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Requirements.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
From the FHIR Standard
Requirements.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
Requirements.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
Requirements.actor:Primary.extension:ActorClassification.value[x]requiredPattern Value: primary
http://moh.bw.org/ValueSet/vs-actor-classification-codes
From this IG
Requirements.actor:Secondary.extension:ActorClassification.value[x]requiredPattern Value: secondary
http://moh.bw.org/ValueSet/vs-actor-classification-codes
From this IG
Requirements.statement.conformancerequiredConformanceExpectation
http://hl7.org/fhir/ValueSet/conformance-expectation|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningRequirementsName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningRequirements.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Requirements

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Requirements.actor

 

Other representations of profile: CSV, Excel, Schematron