New Zealand Rheumatic Fever FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Rheumatic Fever Diagnosis Group

This profile constrains the codes valid on an Observation so it can represent groups of rheumatic fever diagnosis data.

Constraints coding of a standard FHIR Observation for use in RF diagnosis representation

Usages:

• Refer to this Profile: Rheumatic Fever Condition
• Examples for this Profile: Observation/DiagnosisDetail-ECHO, Observation/DiagnosisDetail-JonesCriteria, Observation/DiagnosisDetail-StrepEvidence-Secondary and Observation/DiagnosisDetail-StrepEvidence
• CapabilityStatements using this Profile: Rheumatic Fever FHIR API Capability Statement

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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation	C	0..*	Observation	Measurements and simple assertions Constraints: obs-6, obs-7
meta	ΣC	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business Identifier for observation Slice: Unordered, Open by value:use
identifier:NationalSystem	Σ	0..*	Identifier	This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record.
extension		0..0
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
type	Σ	1..1	CodeableConcept	Description of identifier Binding: External identifier type codes (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example uri: https://standards.digital.health.nz/ns/rfccs
value	Σ	1..1	string	The value that is unique Example General: 123456 Example RFCCS object id: OBS-0207
status	?!Σ	1..1	code	registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
code	Σ	1..1	CodeableConcept	For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required)
hasMember	Σ	0..1	Reference(Observation)	Related resource that belongs to the Observation group
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.identifier:NationalSystem.use	required	Pattern Value: usual http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Observation.identifier:NationalSystem.type	required	ExternalSystemIdentifierTypeValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code From this IG
Observation.status	required	ObservationStatus http://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard
Observation.code	required	RFDiagnosisGroupValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-code From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Observation.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	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	error	Observation	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	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation			Observation
meta	C	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
contained		0..0
Slices for identifier		0..*	Identifier	Business Identifier for observation Slice: Unordered, Open by value:use
identifier:NationalSystem		0..*	Identifier	This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record.
id		0..0
extension		0..0
use		1..1	code	usual | official | temp | secondary | old (If known) Required Pattern: usual
type		1..1	CodeableConcept	Description of identifier Binding: External identifier type codes (required)
system		0..1	uri	The namespace for the identifier value Example uri: https://standards.digital.health.nz/ns/rfccs
value		1..1	string	The value that is unique Example RFCCS object id: OBS-0207
code		1..1	CodeableConcept	For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required)
value[x]		0..0
specimen		0..0
device		0..0
referenceRange		0..0
hasMember		0..1	Reference(Observation)	Related resource that belongs to the Observation group
component
code		1..1	CodeableConcept	Code must uniquely identify component within the Observation group, and be drawn from the RF NZ diagnosis ValueSet Binding: Codes for component observations of NZ rheumatic fever diagnosis (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Observation.identifier:NationalSystem.type	required	ExternalSystemIdentifierTypeValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code From this IG
Observation.code	required	RFDiagnosisGroupValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-code From this IG
Observation.component.code	required	RFDiagnosisObservationCodingValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosis-component-code From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Observation.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation	C	0..*	Observation	Measurements and simple assertions Constraints: obs-6, obs-7
id	Σ	0..1	id	Logical id of this artifact
meta	ΣC	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
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): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business Identifier for observation Slice: Unordered, Open by value:use
identifier:NationalSystem	Σ	0..*	Identifier	This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record.
extension		0..0
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
type	Σ	1..1	CodeableConcept	Description of identifier Binding: External identifier type codes (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example uri: https://standards.digital.health.nz/ns/rfccs
value	Σ	1..1	string	The value that is unique Example General: 123456 Example RFCCS object id: OBS-0207
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)	Fulfills plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)	Part of referenced event
status	?!Σ	1..1	code	registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
category		0..*	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
code	Σ	1..1	CodeableConcept	For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required)
subject	Σ	0..1	Reference(Patient | Group | Device | Location)	Who and/or what the observation is about
focus	Σ	0..*	Reference(Resource)	What the observation is about, when it is not about the subject of record
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	Σ	0..1		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
issued	Σ	0..1	instant	Date/Time this version was made available
performer	Σ	0..*	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)	Who is responsible for the observation
dataAbsentReason	C	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..*	Annotation	Comments about the observation
bodySite		0..1	CodeableConcept	Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method		0..1	CodeableConcept	How it was done Binding: ObservationMethods (example): Methods for simple observations.
hasMember	Σ	0..1	Reference(Observation)	Related resource that belongs to the Observation group
derivedFrom	Σ	0..*	Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)	Related measurements the observation is made from
component	Σ	0..*	BackboneElement	Component results
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
code	Σ	1..1	CodeableConcept	Code must uniquely identify component within the Observation group, and be drawn from the RF NZ diagnosis ValueSet Binding: Codes for component observations of NZ rheumatic fever diagnosis (required)
value[x]	Σ	0..1		Actual component result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange		0..*	See referenceRange (Observation)	Provides guide for interpretation of component result
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Observation.identifier:NationalSystem.use	required	Pattern Value: usual http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Observation.identifier:NationalSystem.type	required	ExternalSystemIdentifierTypeValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code From this IG
Observation.status	required	ObservationStatus http://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.code	required	RFDiagnosisGroupValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-code From this IG
Observation.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.interpretation	extensible	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard
Observation.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site From the FHIR Standard
Observation.method	example	ObservationMethods http://hl7.org/fhir/ValueSet/observation-methods From the FHIR Standard
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes http://hl7.org/fhir/ValueSet/referencerange-meaning From the FHIR Standard
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes http://hl7.org/fhir/ValueSet/referencerange-appliesto From the FHIR Standard
Observation.component.code	required	RFDiagnosisObservationCodingValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosis-component-code From this IG
Observation.component.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.component.interpretation	extensible	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Observation.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	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	error	Observation	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	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

Summary

Mandatory: 0 element(3 nested mandatory elements)
Prohibited: 7 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Observation.identifier

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation	C	0..*	Observation	Measurements and simple assertions Constraints: obs-6, obs-7
meta	ΣC	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business Identifier for observation Slice: Unordered, Open by value:use
identifier:NationalSystem	Σ	0..*	Identifier	This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record.
extension		0..0
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
type	Σ	1..1	CodeableConcept	Description of identifier Binding: External identifier type codes (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example uri: https://standards.digital.health.nz/ns/rfccs
value	Σ	1..1	string	The value that is unique Example General: 123456 Example RFCCS object id: OBS-0207
status	?!Σ	1..1	code	registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
code	Σ	1..1	CodeableConcept	For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required)
hasMember	Σ	0..1	Reference(Observation)	Related resource that belongs to the Observation group
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.identifier:NationalSystem.use	required	Pattern Value: usual http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Observation.identifier:NationalSystem.type	required	ExternalSystemIdentifierTypeValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code From this IG
Observation.status	required	ObservationStatus http://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard
Observation.code	required	RFDiagnosisGroupValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-code From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Observation.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	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	error	Observation	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	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

This structure is derived from Observation

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation			Observation
meta	C	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
contained		0..0
Slices for identifier		0..*	Identifier	Business Identifier for observation Slice: Unordered, Open by value:use
identifier:NationalSystem		0..*	Identifier	This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record.
id		0..0
extension		0..0
use		1..1	code	usual | official | temp | secondary | old (If known) Required Pattern: usual
type		1..1	CodeableConcept	Description of identifier Binding: External identifier type codes (required)
system		0..1	uri	The namespace for the identifier value Example uri: https://standards.digital.health.nz/ns/rfccs
value		1..1	string	The value that is unique Example RFCCS object id: OBS-0207
code		1..1	CodeableConcept	For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required)
value[x]		0..0
specimen		0..0
device		0..0
referenceRange		0..0
hasMember		0..1	Reference(Observation)	Related resource that belongs to the Observation group
component
code		1..1	CodeableConcept	Code must uniquely identify component within the Observation group, and be drawn from the RF NZ diagnosis ValueSet Binding: Codes for component observations of NZ rheumatic fever diagnosis (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Observation.identifier:NationalSystem.type	required	ExternalSystemIdentifierTypeValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code From this IG
Observation.code	required	RFDiagnosisGroupValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-code From this IG
Observation.component.code	required	RFDiagnosisObservationCodingValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosis-component-code From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Observation.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Observation	C	0..*	Observation	Measurements and simple assertions Constraints: obs-6, obs-7
id	Σ	0..1	id	Logical id of this artifact
meta	ΣC	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
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): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business Identifier for observation Slice: Unordered, Open by value:use
identifier:NationalSystem	Σ	0..*	Identifier	This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record.
extension		0..0
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
type	Σ	1..1	CodeableConcept	Description of identifier Binding: External identifier type codes (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example uri: https://standards.digital.health.nz/ns/rfccs
value	Σ	1..1	string	The value that is unique Example General: 123456 Example RFCCS object id: OBS-0207
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)	Fulfills plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)	Part of referenced event
status	?!Σ	1..1	code	registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
category		0..*	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
code	Σ	1..1	CodeableConcept	For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required)
subject	Σ	0..1	Reference(Patient | Group | Device | Location)	Who and/or what the observation is about
focus	Σ	0..*	Reference(Resource)	What the observation is about, when it is not about the subject of record
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	Σ	0..1		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
issued	Σ	0..1	instant	Date/Time this version was made available
performer	Σ	0..*	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)	Who is responsible for the observation
dataAbsentReason	C	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..*	Annotation	Comments about the observation
bodySite		0..1	CodeableConcept	Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method		0..1	CodeableConcept	How it was done Binding: ObservationMethods (example): Methods for simple observations.
hasMember	Σ	0..1	Reference(Observation)	Related resource that belongs to the Observation group
derivedFrom	Σ	0..*	Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)	Related measurements the observation is made from
component	Σ	0..*	BackboneElement	Component results
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
code	Σ	1..1	CodeableConcept	Code must uniquely identify component within the Observation group, and be drawn from the RF NZ diagnosis ValueSet Binding: Codes for component observations of NZ rheumatic fever diagnosis (required)
value[x]	Σ	0..1		Actual component result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange		0..*	See referenceRange (Observation)	Provides guide for interpretation of component result
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Observation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Observation.identifier:NationalSystem.use	required	Pattern Value: usual http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Observation.identifier:NationalSystem.type	required	ExternalSystemIdentifierTypeValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code From this IG
Observation.status	required	ObservationStatus http://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes http://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard
Observation.code	required	RFDiagnosisGroupValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-code From this IG
Observation.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.interpretation	extensible	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard
Observation.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site From the FHIR Standard
Observation.method	example	ObservationMethods http://hl7.org/fhir/ValueSet/observation-methods From the FHIR Standard
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes http://hl7.org/fhir/ValueSet/referencerange-meaning From the FHIR Standard
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes http://hl7.org/fhir/ValueSet/referencerange-appliesto From the FHIR Standard
Observation.component.code	required	RFDiagnosisObservationCodingValueSet https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosis-component-code From this IG
Observation.component.dataAbsentReason	extensible	DataAbsentReason http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Observation.component.interpretation	extensible	ObservationInterpretationCodes http://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Observation.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	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	error	Observation	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	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

Summary

Mandatory: 0 element(3 nested mandatory elements)
Prohibited: 7 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Observation.identifier

Other representations of profile: CSV, Excel, Schematron