Current Build

​ D.4.1 StructureDefinition: hspc-CTrachAndGcRrnaVagQlPrb

​D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/fpar/StructureDefinition/hspc-CTrachAndGcRrnaVagQlPrb

This profile builds on http://hl7.org/fhir/fpar/StructureDefinition/hspc-stdord.

This profile was published on Mon May 15 00:00:00 EDT 2017 as a draft by HSPC.

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

​This structure is derived from

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 2 elements
Fixed Value: 1 element

​This structure is derived from

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IC trach+GC rRNA Vag Ql Prb
1: Must have either a value or a dataAbsentReason but not both
... code S1..1CodeableConceptLaboratory Test Name
Binding: HSPC Ordinal Labs (preferred)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"45070-0","display":"Chlamydia trachomatis+Neisseria gonorrhoeae rRNA [Presence] in Vaginal fluid by DNA probe"}]}
... valueCodeableConcept SΣI0..1CodeableConceptResult Value
Binding: FPAR Organism Detection Ordinal Lab Result value set (preferred)
us-core-4: SHOULD use Snomed CT for coded Results

doco Documentation for this format

​This structure is derived from

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*C trach+GC rRNA Vag Ql Prb
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)Fulfills plan, proposal or order
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SI1..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
us-core-5: Must have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category'
... code SΣ1..1CodeableConceptLaboratory Test Name
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"45070-0","display":"Chlamydia trachomatis+Neisseria gonorrhoeae rRNA [Presence] in Vaginal fluid by DNA probe"}]}
... subject SΣ1..1Reference()Who and/or what this is about
... context 0..1Reference(EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] SΣI0..1dateTime, PeriodClinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(http://hl7.org/fhir/fpar/StructureDefinition/hspc-practitioner | http://hl7.org/fhir/fpar/StructureDefinition/hpsc-organization | http://hl7.org/fhir/fpar/StructureDefinition/hspc-patient | RelatedPerson)Who is responsible for the observation
... valueCodeableConcept SΣI0..1CodeableConceptResult Value
Binding: FPAR Organism Detection Ordinal Lab Result value set (preferred)
us-core-4: SHOULD use Snomed CT for coded Results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding 0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code 1..1codeSymbol in syntax defined by the system
Binding: HSPC Findings Value Set Definition (preferred)
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: HSPC Lab Null Flavor (preferred)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nom (preferred)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I1..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type 0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (extensible)
.... text 1..1stringText based reference range in an observation
... related ΣI0..*BackboneElementResource 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 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(Observation | QuestionnaireResponse | Sequence)Resource that is related to this one

doco Documentation for this format

​This structure is derived from

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 2 elements
Fixed Value: 1 element

Differential View

​This structure is derived from

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IC trach+GC rRNA Vag Ql Prb
1: Must have either a value or a dataAbsentReason but not both
... code S1..1CodeableConceptLaboratory Test Name
Binding: HSPC Ordinal Labs (preferred)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"45070-0","display":"Chlamydia trachomatis+Neisseria gonorrhoeae rRNA [Presence] in Vaginal fluid by DNA probe"}]}
... valueCodeableConcept SΣI0..1CodeableConceptResult Value
Binding: FPAR Organism Detection Ordinal Lab Result value set (preferred)
us-core-4: SHOULD use Snomed CT for coded Results

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*C trach+GC rRNA Vag Ql Prb
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)Fulfills plan, proposal or order
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SI1..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
us-core-5: Must have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category'
... code SΣ1..1CodeableConceptLaboratory Test Name
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"45070-0","display":"Chlamydia trachomatis+Neisseria gonorrhoeae rRNA [Presence] in Vaginal fluid by DNA probe"}]}
... subject SΣ1..1Reference()Who and/or what this is about
... context 0..1Reference(EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] SΣI0..1dateTime, PeriodClinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(http://hl7.org/fhir/fpar/StructureDefinition/hspc-practitioner | http://hl7.org/fhir/fpar/StructureDefinition/hpsc-organization | http://hl7.org/fhir/fpar/StructureDefinition/hspc-patient | RelatedPerson)Who is responsible for the observation
... valueCodeableConcept SΣI0..1CodeableConceptResult Value
Binding: FPAR Organism Detection Ordinal Lab Result value set (preferred)
us-core-4: SHOULD use Snomed CT for coded Results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding 0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code 1..1codeSymbol in syntax defined by the system
Binding: HSPC Findings Value Set Definition (preferred)
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: HSPC Lab Null Flavor (preferred)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nom (preferred)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I1..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type 0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (extensible)
.... text 1..1stringText based reference range in an observation
... related ΣI0..*BackboneElementResource 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 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(Observation | QuestionnaireResponse | Sequence)Resource that is related to this one

doco Documentation for this format

 

​D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Observation.languageCommon LanguagesextensibleCommon Languages
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodespreferredObservation Category Codes
Observation.valueCodeableConceptFPAR Organism Detection Ordinal Lab Result value setpreferredFPAR Organism Detection Ordinal Lab Result value set
Observation.valueCodeableConcept.coding.codeHSPC Findings Value Set DefinitionpreferredHSPC Findings Value Set Definition
Observation.dataAbsentReasonHSPC Lab Null FlavorpreferredHSPC Lab Null Flavor
Observation.interpretationAbnormal Interpretation Numeric NompreferredAbnormal Interpretation Numeric Nom
Observation.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Observation.methodObservation MethodsexampleObservation Methods
Observation.referenceRange.typeObservation Reference Range Meaning CodesextensibleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.component.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes

​D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ObservationIf 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-3ObservationIf 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()
obs-7ObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or code!=component.code
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
us-core-2ObservationIf there is no component or related element then either a value[x] or a data absent reason must be present
: (component.empty() and related.empty()) implies (dataAbsentReason or value)
us-core-5Observation.categoryMust have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category'
: where(coding.system='http://hl7.org/fhir/observation-category' and coding.code='laboratory').exists()
us-core-1Observation.effective[x]Datetime must be at least to day.
: ($this as dateTime).toString().length() >= 8
us-core-4Observation.valueCodeableConceptSHOULD use Snomed CT for coded Results
: valueCodeableConcept.coding.system.empty() or valueCodeableConcept.coding.system = 'http://snomed.info/sct'
ele-1Observation.referenceRangeAll FHIR elements must have a @value or children
: children().count() > id.count()
obs-3Observation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
ele-1Observation.relatedAll FHIR elements must have a @value or children
: children().count() > id.count()
.