Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.

Resource Profile: InterweaveObservationPregnancyEDD

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-Observation-Pregnancy-EDD Version: 0.1.0
Active as of 2024-07-17 Computable Name: InterweaveObservationPregnancyEDD

Interweave Pregnancy Estimated Delivery Date resource profile.

  Status: Active: Approved (STU)

Introduction

This profile sets out the expectations for the interweave preganancy Estimated date of delivery observation resource. Care connect do not have a profile for this observation, and therefore the base for this profile is the Interweave-Observation. We stipulate the use of SNOMED concept codes where possible and have removed the component field. This is to ensure that the valueQuantity field is used to provide the result.

Mandatory fields

The following mandatory fields are defined:

  1. status – Fixed value of ‘final’. We use the required binding supplied by care connect for the observation status. As stated in the introduction, only finalised observations should be shared.

  2. category – The classification of the type of observation e.g. exam, survey, vital-signs etc. We require that the FHIR Observation category is always populated. There is also an option to provide additional local categories to enable FHIR searching on local categories.

  3. code – The SNOMED CT coded value to represent, which method was used to derive the observation for estimated delivery date.

  4. subject – Reference to the patient who is the subject of this measurement.

  5. effective – An important field to provide details of the date/time at during which the observation was taken.

  6. valueDateTime – The actual result recorded.

Must Support fields

In addition the following fields are “Must Support” - ie they must be populated if relevant and known.

  1. identifier – A Local Id should be provided, such that could be quoted if manually getting in touch to find out more.

  2. performer – We limit this field to reference practitioner resources only. The organization responsible for the observation can be obtained via the provenance tag.

  3. comment – Comments in addition to the result are often recorded for observations, it is therefore important to provide this field when available to give the consumer the full result information.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Points of note include:

  • context – Optional link to an encounter resource.

  • related – To reduce complexity, we limit the related field’s usage to only allow links to observation resources, from which the primary observation’s value was derived. E.g. An observation may have a value which is a score, and that score may have been derived from several other observations.

Discouraged or Removed fields

  • Component – Removed to aid the data consumer, we ask that the result is provided in the valueQuantity field and not as a component.

  • basedOn – This field is discouraged as it does not appear to provide information which would be beneficial in a shared care record. It also allows references to a raft of request/order resources which introduces a lot of complexity for a data consumer.

  • issued – This field has been removed as this information can be taken from the mandatory meta.lastUpdated field, and to also avoid any confusion with the other date fields.

  • interpretation
  • referenceRange
  • specimen
  • device
  • dataAbsentReason
  • bodySite
  • method

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from InterweaveObservation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*InterweaveObservationMeasurements and simple assertions
... extension:reason 0..0
... status 1..1codeFixed value of ‘final’.
Fixed Value: final
... category 1..*CodeableConceptClassification of type of observation
.... coding:snomedCT 0..0
.... coding 1..*CodingCode defined by a terminology system
.... coding:snomedCT 1..1CodingCode defined by a terminology system
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
... effective[x] 1..1dateTimeThis is the time/time period during which the observation was taken.
... value[x] 1..1dateTimeActual result.
... dataAbsentReason 0..0
... interpretation 0..0
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... component 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.coderequiredInterweave Pregnancy Estimated date of delivery Code
Observation.code.coding:snomedCTrequiredInterweave Pregnancy Estimated date of delivery Code
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*InterweaveObservationMeasurements and simple assertions
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... status ?!SΣ1..1codeFixed value of ‘final’.
Binding: ObservationStatus (required)
Fixed Value: final
... Slices for category S1..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by value:coding.system
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


.... category:All Slices Content/Rules for all slices
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... category:observationCategory 1..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (required): Codes for high level observation categories.


..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:All Slices Content/Rules for all slices
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT SΣ1..1CodingCode defined by a terminology system
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... subject SΣ1..1Reference(CareConnectPatient1)The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... display Σ1..1stringDescription of the referenced resource
... effective[x] SΣ1..1dateTimeThis is the time/time period during which the observation was taken.
... performer SΣ0..*Reference(CareConnect-Practitioner-1)Who is responsible for the observation.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... display Σ1..1stringDescription of the referenced resource
... value[x] SΣC1..1dateTimeActual result.
... comment S0..1stringComments about the result
... related SΣ0..*BackboneElementResources related to this observation
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type S1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.


Fixed Value: derived-from
.... target S1..1Reference(CareConnect-Observation-1)we limit the related field’s usage to only allow links to observation resources, from which the primary observation’s value was derived. E.g. An observation may have a value which is a score, and that score may have been derived from several other observations.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.meta.tagexampleCommon Tags
Observation.meta.tag:SourceexampleCommon Tags
Observation.meta.tag:ProvenanceexampleCommon Tags
Observation.identifier.userequiredIdentifierUse
Observation.statusrequiredFixed Value: final
Observation.categorypreferredObservation Category Codes
Observation.category:observationCategoryrequiredObservation Category Codes
Observation.coderequiredInterweave Pregnancy Estimated date of delivery Code
Observation.code.coding:snomedCTrequiredInterweave Pregnancy Estimated date of delivery Code
Observation.related.typerequiredFixed Value: derived-from
Observation.component.codepreferredCare Connect Observation Type
Observation.component.code.coding:snomedCTpreferredCare Connect Observation Type

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*InterweaveObservationMeasurements and simple assertions
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... valuePrecision 0..1integerExplicit precision of the number
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-ValuePrecision
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)DISCOURAGED - This field does not appear to provide information which would be beneficial in a shared care record. It also allows references to a raft of request/order resources which introduces a lot of complexity for a data consumer.
... status ?!SΣ1..1codeFixed value of ‘final’.
Binding: ObservationStatus (required)
Fixed Value: final
... Slices for category S1..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by value:coding.system
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


.... category:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... text Σ0..1stringPlain text representation of the concept
.... category:observationCategory 1..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (required): Codes for high level observation categories.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:All Slices Content/Rules for all slices
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT SΣ1..1CodingCode defined by a terminology system
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..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(CareConnectPatient1)The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context 0..1Reference(CareConnect-Encounter-1)The encounter during which this observation is made.
... effective[x] SΣ1..1dateTimeThis is the time/time period during which the observation was taken.
... performer SΣ0..*Reference(CareConnect-Practitioner-1)Who is responsible for the observation.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... value[x] SΣC1..1dateTimeActual result.
... comment S0..1stringComments about the result
... related SΣ0..*BackboneElementResources related to this observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type S1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.


Fixed Value: derived-from
.... target S1..1Reference(CareConnect-Observation-1)we limit the related field’s usage to only allow links to observation resources, from which the primary observation’s value was derived. E.g. An observation may have a value which is a score, and that score may have been derived from several other observations.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.meta.securityextensibleAll Security Labels
Observation.meta.tagexampleCommon Tags
Observation.meta.tag:SourceexampleCommon Tags
Observation.meta.tag:ProvenanceexampleCommon Tags
Observation.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.identifier.userequiredIdentifierUse
Observation.identifier.typeextensibleIdentifier Type Codes
Observation.statusrequiredFixed Value: final
Observation.categorypreferredObservation Category Codes
Observation.category:observationCategoryrequiredObservation Category Codes
Observation.coderequiredInterweave Pregnancy Estimated date of delivery Code
Observation.code.coding:snomedCTrequiredInterweave Pregnancy Estimated date of delivery Code
Observation.referenceRange.typeextensibleObservation Reference Range Meaning Codes
Observation.referenceRange.appliesToexampleObservation Reference Range Applies To Codes
Observation.related.typerequiredFixed Value: derived-from
Observation.component.codepreferredCare Connect Observation Type
Observation.component.code.coding:snomedCTpreferredCare Connect Observation Type
Observation.component.dataAbsentReasonextensibleObservation Value Absent Reason
Observation.component.interpretationextensibleObservation Interpretation Codes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (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 InterweaveObservation

Summary

Mandatory: 3 elements
Fixed Value: 1 element
Prohibited: 10 elements

Differential View

This structure is derived from InterweaveObservation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*InterweaveObservationMeasurements and simple assertions
... extension:reason 0..0
... status 1..1codeFixed value of ‘final’.
Fixed Value: final
... category 1..*CodeableConceptClassification of type of observation
.... coding:snomedCT 0..0
.... coding 1..*CodingCode defined by a terminology system
.... coding:snomedCT 1..1CodingCode defined by a terminology system
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
... effective[x] 1..1dateTimeThis is the time/time period during which the observation was taken.
... value[x] 1..1dateTimeActual result.
... dataAbsentReason 0..0
... interpretation 0..0
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... component 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.coderequiredInterweave Pregnancy Estimated date of delivery Code
Observation.code.coding:snomedCTrequiredInterweave Pregnancy Estimated date of delivery Code

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*InterweaveObservationMeasurements and simple assertions
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... status ?!SΣ1..1codeFixed value of ‘final’.
Binding: ObservationStatus (required)
Fixed Value: final
... Slices for category S1..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by value:coding.system
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


.... category:All Slices Content/Rules for all slices
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... category:observationCategory 1..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (required): Codes for high level observation categories.


..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:All Slices Content/Rules for all slices
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT SΣ1..1CodingCode defined by a terminology system
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... subject SΣ1..1Reference(CareConnectPatient1)The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... display Σ1..1stringDescription of the referenced resource
... effective[x] SΣ1..1dateTimeThis is the time/time period during which the observation was taken.
... performer SΣ0..*Reference(CareConnect-Practitioner-1)Who is responsible for the observation.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... display Σ1..1stringDescription of the referenced resource
... value[x] SΣC1..1dateTimeActual result.
... comment S0..1stringComments about the result
... related SΣ0..*BackboneElementResources related to this observation
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type S1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.


Fixed Value: derived-from
.... target S1..1Reference(CareConnect-Observation-1)we limit the related field’s usage to only allow links to observation resources, from which the primary observation’s value was derived. E.g. An observation may have a value which is a score, and that score may have been derived from several other observations.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.meta.tagexampleCommon Tags
Observation.meta.tag:SourceexampleCommon Tags
Observation.meta.tag:ProvenanceexampleCommon Tags
Observation.identifier.userequiredIdentifierUse
Observation.statusrequiredFixed Value: final
Observation.categorypreferredObservation Category Codes
Observation.category:observationCategoryrequiredObservation Category Codes
Observation.coderequiredInterweave Pregnancy Estimated date of delivery Code
Observation.code.coding:snomedCTrequiredInterweave Pregnancy Estimated date of delivery Code
Observation.related.typerequiredFixed Value: derived-from
Observation.component.codepreferredCare Connect Observation Type
Observation.component.code.coding:snomedCTpreferredCare Connect Observation Type

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*InterweaveObservationMeasurements and simple assertions
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... valuePrecision 0..1integerExplicit precision of the number
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-ValuePrecision
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)DISCOURAGED - This field does not appear to provide information which would be beneficial in a shared care record. It also allows references to a raft of request/order resources which introduces a lot of complexity for a data consumer.
... status ?!SΣ1..1codeFixed value of ‘final’.
Binding: ObservationStatus (required)
Fixed Value: final
... Slices for category S1..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by value:coding.system
Binding: Observation Category Codes (preferred): Codes for high level observation categories.


.... category:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... text Σ0..1stringPlain text representation of the concept
.... category:observationCategory 1..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (required): Codes for high level observation categories.


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:All Slices Content/Rules for all slices
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT SΣ1..1CodingCode defined by a terminology system
Binding: Interweave Pregnancy Estimated date of delivery Code (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..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(CareConnectPatient1)The patient whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context 0..1Reference(CareConnect-Encounter-1)The encounter during which this observation is made.
... effective[x] SΣ1..1dateTimeThis is the time/time period during which the observation was taken.
... performer SΣ0..*Reference(CareConnect-Practitioner-1)Who is responsible for the observation.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... value[x] SΣC1..1dateTimeActual result.
... comment S0..1stringComments about the result
... related SΣ0..*BackboneElementResources related to this observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type S1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.


Fixed Value: derived-from
.... target S1..1Reference(CareConnect-Observation-1)we limit the related field’s usage to only allow links to observation resources, from which the primary observation’s value was derived. E.g. An observation may have a value which is a score, and that score may have been derived from several other observations.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.meta.securityextensibleAll Security Labels
Observation.meta.tagexampleCommon Tags
Observation.meta.tag:SourceexampleCommon Tags
Observation.meta.tag:ProvenanceexampleCommon Tags
Observation.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.identifier.userequiredIdentifierUse
Observation.identifier.typeextensibleIdentifier Type Codes
Observation.statusrequiredFixed Value: final
Observation.categorypreferredObservation Category Codes
Observation.category:observationCategoryrequiredObservation Category Codes
Observation.coderequiredInterweave Pregnancy Estimated date of delivery Code
Observation.code.coding:snomedCTrequiredInterweave Pregnancy Estimated date of delivery Code
Observation.referenceRange.typeextensibleObservation Reference Range Meaning Codes
Observation.referenceRange.appliesToexampleObservation Reference Range Applies To Codes
Observation.related.typerequiredFixed Value: derived-from
Observation.component.codepreferredCare Connect Observation Type
Observation.component.code.coding:snomedCTpreferredCare Connect Observation Type
Observation.component.dataAbsentReasonextensibleObservation Value Absent Reason
Observation.component.interpretationextensibleObservation Interpretation Codes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (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 InterweaveObservation

Summary

Mandatory: 3 elements
Fixed Value: 1 element
Prohibited: 10 elements

 

Other representations of profile: CSV, Excel, Schematron