Release 4 R5 Final QA

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-draft-final: Final QA Preview for R5 - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Specimendefinition.shex

10.3.13.14 StructureDefinition: ExampleLipidProfile

Orders and Observations icon Work Group   Maturity Level : N/A 0 Standards Status : Informative Trial Use Compartments Use Context : Not linked to any defined compartments yet ready for Production use

Raw ShEx The canonical URL for this profile is: 


http://hl7.org/fhir/StructureDefinition/triglyceride

Triglyceride Result

This profile was published on Sat, Feb 21, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - FHIR WG.

10.3.13.14.1 Formal Views of Profile Content

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

ShEx statement This structure is derived from Observation .

Summary

Mandatory: 3 elements
Must-Support: 5 elements
Prohibited: 6 elements

This indicates the differences between this profile and the base Observation structure.

Name Flags Card. Type Description & Constraints doco
.. Observation 1..1 Observation Triglyceride Result
... code S 1..1 CodeableConcept Triglyceride
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 35217-9
..... display 1..1 string Representation defined by the system
Fixed Value: Triglyceride [Moles/​volume] in Serum or Plasma
... valueQuantity S 0..1 Quantity Triglyceride value
... interpretation S 0..1 CodeableConcept + | ++ | +++ | - | -- | ---
... referenceRange S 1..1 BackboneElement Provides guide for specimendefinition interpretation
.... low 0 .. 0
.... high 1..1 SimpleQuantity High Range, if relevant
.... type 0 .. 0
.... appliesTo 0 .. 0
.... age 0 .. 0
... hasMember 0 .. 0
... derivedFrom 0 .. 0

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Observation structure.

PREFIX fhir: <http://hl7.org/fhir/> PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/> PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> BASE <http://hl7.org/fhir/shape/> start=@<SpecimenDefinition> AND {fhir:nodeRole [fhir:treeRoot]} # Kind of specimen <SpecimenDefinition> CLOSED { a [fhir:SpecimenDefinition]; fhir:nodeRole [fhir:treeRoot]?; fhir:Resource.id @<http://hl7.org/fhirpath/System.String>?; # Logical id of this artifact fhir:Resource.meta @<Meta>?; # Metadata about the resource fhir:Resource.implicitRules @<uri>?; # A set of rules under which this # content was created fhir:Resource.language @<code>?; # Language of the resource content fhir:DomainResource.text @<Narrative>?; # Text summary of the resource, for # human interpretation fhir:DomainResource.contained @<Resource>*; # Contained, inline Resources fhir:DomainResource.extension @<Extension>*; # Additional content defined by # implementations fhir:DomainResource.modifierExtension @<Extension>*; # Extensions that cannot be ignored fhir:SpecimenDefinition.identifier @<Identifier>?; # Business identifier of a kind of # specimen fhir:SpecimenDefinition.typeCollected @<CodeableConcept>?; # Kind of material to collect fhir:SpecimenDefinition.patientPreparation @<CodeableConcept>*; # Patient preparation for collection fhir:SpecimenDefinition.timeAspect @<string>?; # Time aspect for collection fhir:SpecimenDefinition.collection @<CodeableConcept>*; # Specimen collection procedure fhir:SpecimenDefinition.typeTested @<SpecimenDefinition.typeTested>*; # Specimen in container intended for # testing by lab fhir:index xsd:integer? # Relative position in a list } # Specimen in container intended for testing by lab <SpecimenDefinition.typeTested> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored # even if unrecognized fhir:SpecimenDefinition.typeTested.isDerived @<boolean>?; # Primary or secondary specimen fhir:SpecimenDefinition.typeTested.type @<CodeableConcept>?; # Type of intended specimen fhir:SpecimenDefinition.typeTested.preference @<code> AND {fhir:value @fhirvs:specimen-contained-preference}; # preferred | alternate fhir:SpecimenDefinition.typeTested.container @<SpecimenDefinition.typeTested.container>?; # The specimen's container fhir:SpecimenDefinition.typeTested.requirement @<string>?; # Specimen requirements fhir:SpecimenDefinition.typeTested.retentionTime @<Duration>?; # Specimen retention time fhir:SpecimenDefinition.typeTested.rejectionCriterion @<CodeableConcept>*; # Rejection criterion fhir:SpecimenDefinition.typeTested.handling @<SpecimenDefinition.typeTested.handling>*; # Specimen handling before testing fhir:index xsd:integer? # Relative position in a list } # Specimen handling before testing <SpecimenDefinition.typeTested.handling> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored # even if unrecognized fhir:SpecimenDefinition.typeTested.handling.temperatureQualifier @<CodeableConcept>?; # Temperature qualifier fhir:SpecimenDefinition.typeTested.handling.temperatureRange @<Range>?; # Temperature range fhir:SpecimenDefinition.typeTested.handling.maxDuration @<Duration>?; # Maximum preservation time fhir:SpecimenDefinition.typeTested.handling.instruction @<string>?; # Preservation instruction fhir:index xsd:integer? # Relative position in a list } # The specimen's container <SpecimenDefinition.typeTested.container> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored # even if unrecognized fhir:SpecimenDefinition.typeTested.container.material @<CodeableConcept>?; # Container material fhir:SpecimenDefinition.typeTested.container.type @<CodeableConcept>?; # Kind of container associated with # the kind of specimen fhir:SpecimenDefinition.typeTested.container.cap @<CodeableConcept>?; # Color of container cap fhir:SpecimenDefinition.typeTested.container.description @<string>?; # Container description fhir:SpecimenDefinition.typeTested.container.capacity @<SimpleQuantity>?; # Container capacity ( # Minimum volume fhir:SpecimenDefinition.typeTested.container.minimumVolumeQuantity @<SimpleQuantity> | fhir:SpecimenDefinition.typeTested.container.minimumVolumeString @<string> )?; fhir:SpecimenDefinition.typeTested.container.additive @<SpecimenDefinition.typeTested.container.additive>*; # Additive associated with container fhir:SpecimenDefinition.typeTested.container.preparation @<string>?; # Specimen container preparation fhir:index xsd:integer? # Relative position in a list } # Additive associated with container <SpecimenDefinition.typeTested.container.additive> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored # even if unrecognized ( # Additive associated with container fhir:SpecimenDefinition.typeTested.container.additive.additiveCodeableConcept @<CodeableConcept> | fhir:SpecimenDefinition.typeTested.container.additive.additiveReference @<Reference> ); fhir:index xsd:integer? # Relative position in a list } #---------------------- Data Types ------------------- # Metadata about a resource <Meta> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Meta.versionId @<id>?; # Version specific identifier fhir:Meta.lastUpdated @<instant>?; # When the resource version last # changed fhir:Meta.source @<uri>?; # Identifies where the resource # comes from fhir:Meta.profile @<canonical>*; # Profiles this resource claims to # conform to fhir:Meta.security @<Coding>*; # Security Labels applied to this # resource fhir:Meta.tag @<Coding>*; # Tags applied to this resource fhir:index xsd:integer? # Relative position in a list } # Primitive Type code <code> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for code fhir:index xsd:integer? # Relative position in a list } # Primitive Type string <string> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for string fhir:index xsd:integer? # Relative position in a list } # A reference from one resource to another <Reference> CLOSED { fhir:link IRI?; fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Reference.reference @<string>?; # Literal reference, Relative, # internal or absolute URL fhir:Reference.type @<uri>?; # Type the reference refers to (e.g. # "Patient") fhir:Reference.identifier @<Identifier>?; # Logical reference, when literal # reference is not known fhir:Reference.display @<string>?; # Text alternative for the resource fhir:index xsd:integer? # Relative position in a list } # Base Resource <Resource> {a .+; fhir:Resource.id @<http://hl7.org/fhirpath/System.String>?; # Logical id of this artifact fhir:Resource.meta @<Meta>?; # Metadata about the resource fhir:Resource.implicitRules @<uri>?; # A set of rules under which this # content was created fhir:Resource.language @<code>?; # Language of the resource content fhir:index xsd:integer? } # A fixed quantity (no comparator) <SimpleQuantity> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # A length of time <Duration> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.comparator @<code> AND {fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to # understand the value fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # Set of values bounded by low and high <Range> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Range.low @<SimpleQuantity>?; # Low limit fhir:Range.high @<SimpleQuantity>?; # High limit fhir:index xsd:integer? # Relative position in a list } # Primitive Type uri <uri> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for uri fhir:index xsd:integer? # Relative position in a list } # Optional Extensions Element <Extension> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; fhir:Element.extension @<Extension>*; fhir:Extension.url @<http://hl7.org/fhirpath/System.String>; ( fhir:Extension.valueBase64Binary @<base64Binary> | fhir:Extension.valueBoolean @<boolean> | fhir:Extension.valueCanonical @<canonical> | fhir:Extension.valueCode @<code> | fhir:Extension.valueDate @<date> | fhir:Extension.valueDateTime @<dateTime> | fhir:Extension.valueDecimal @<decimal> | fhir:Extension.valueId @<id> | fhir:Extension.valueInstant @<instant> | fhir:Extension.valueInteger @<integer> | fhir:Extension.valueMarkdown @<markdown> | fhir:Extension.valueOid @<oid> | fhir:Extension.valuePositiveInt @<positiveInt> | fhir:Extension.valueString @<string> | fhir:Extension.valueTime @<time> | fhir:Extension.valueUnsignedInt @<unsignedInt> | fhir:Extension.valueUri @<uri> | fhir:Extension.valueUrl @<url> | fhir:Extension.valueUuid @<uuid> | fhir:Extension.valueAddress @<Address> | fhir:Extension.valueAge @<Age> | fhir:Extension.valueAnnotation @<Annotation> | fhir:Extension.valueAttachment @<Attachment> | fhir:Extension.valueCodeableConcept @<CodeableConcept> | fhir:Extension.valueCoding @<Coding> | fhir:Extension.valueContactPoint @<ContactPoint> | fhir:Extension.valueCount @<Count> | fhir:Extension.valueDistance @<Distance> | fhir:Extension.valueDuration @<Duration> | fhir:Extension.valueHumanName @<HumanName> | fhir:Extension.valueIdentifier @<Identifier> | fhir:Extension.valueMoney @<Money> | fhir:Extension.valuePeriod @<Period> | fhir:Extension.valueQuantity @<Quantity> | fhir:Extension.valueRange @<Range> | fhir:Extension.valueRatio @<Ratio> | fhir:Extension.valueReference @<Reference> | fhir:Extension.valueSampledData @<SampledData> | fhir:Extension.valueSignature @<Signature> | fhir:Extension.valueTiming @<Timing> | fhir:Extension.valueContactDetail @<ContactDetail> | fhir:Extension.valueContributor @<Contributor> | fhir:Extension.valueDataRequirement @<DataRequirement> | fhir:Extension.valueExpression @<Expression> | fhir:Extension.valueParameterDefinition @<ParameterDefinition> | fhir:Extension.valueRelatedArtifact @<RelatedArtifact> | fhir:Extension.valueTriggerDefinition @<TriggerDefinition> | fhir:Extension.valueUsageContext @<UsageContext> | fhir:Extension.valueDosage @<Dosage> | fhir:Extension.valueMeta @<Meta> )?; fhir:index xsd:integer? # Relative position in a list } # An identifier intended for computation <Identifier> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Identifier.use @<code> AND {fhir:value @fhirvs:identifier-use}?; # usual | official | temp | # secondary | old (If known) fhir:Identifier.type @<CodeableConcept>?; # Description of identifier fhir:Identifier.system @<uri>?; # The namespace for the identifier # value fhir:Identifier.value @<string>?; # The value that is unique fhir:Identifier.period @<Period>?; # Time period when id is/was valid # for use fhir:Identifier.assigner @<Reference>?; # Organization that issued id (may # be just text) fhir:index xsd:integer? # Relative position in a list } # Primitive Type boolean <boolean> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.Boolean>?; # Primitive value for boolean fhir:index xsd:integer? # Relative position in a list } # Human-readable summary of the resource (essential clinical and business information) <Narrative> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Narrative.status @<code> AND {fhir:value @fhirvs:narrative-status}; # generated | extensions | # additional | empty fhir:Narrative.div xsd:string; # Limited xhtml content fhir:index xsd:integer? # Relative position in a list } # Concept - reference to a terminology or just text <CodeableConcept> CLOSED { a NONLITERAL*; fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:CodeableConcept.coding @<Coding>*; # Code defined by a terminology # system fhir:CodeableConcept.text @<string>?; # Plain text representation of the # concept fhir:index xsd:integer? # Relative position in a list } # Primitive Type date <date> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.Date>?; # Primitive value for date fhir:index xsd:integer? # Relative position in a list } # An address expressed using postal conventions (as opposed to GPS or other location definition formats) <Address> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Address.use @<code> AND {fhir:value @fhirvs:address-use}?; # home | work | temp | old | billing # - purpose of this address fhir:Address.type @<code> AND {fhir:value @fhirvs:address-type}?; # postal | physical | both fhir:Address.text @<string>?; # Text representation of the address fhir:Address.line @<string>*; # Street name, number, direction & # P.O. Box etc. fhir:Address.city @<string>?; # Name of city, town etc. fhir:Address.district @<string>?; # District name (aka county) fhir:Address.state @<string>?; # Sub-unit of country (abbreviations # ok) fhir:Address.postalCode @<string>?; # Postal code for area fhir:Address.country @<string>?; # Country (e.g. can be ISO 3166 2 or # 3 letter code) fhir:Address.period @<Period>?; # Time period when address was/is in # use fhir:index xsd:integer? # Relative position in a list } # Content in a format defined elsewhere <Attachment> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Attachment.contentType @<code> AND {fhir:value @fhirvs:mimetypes}?; # Mime type of the content, with # charset etc. fhir:Attachment.language @<code>?; # Human language of the content # (BCP-47) fhir:Attachment.data @<base64Binary>?; # Data inline, base64ed fhir:Attachment.url @<url>?; # Uri where the data can be found fhir:Attachment.size @<unsignedInt>?; # Number of bytes of content (if url # provided) fhir:Attachment.hash @<base64Binary>?; # Hash of the data (sha-1, base64ed) fhir:Attachment.title @<string>?; # Label to display in place of the # data fhir:Attachment.creation @<dateTime>?; # Date attachment was first created fhir:index xsd:integer? # Relative position in a list } # Primitive Type integer <integer> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.Integer>?; # Primitive value for integer fhir:index xsd:integer? # Relative position in a list } # A measured or measurable amount <Count> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.comparator @<code> AND {fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to # understand the value fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # Describes a required data item <DataRequirement> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:DataRequirement.type @<code> AND {fhir:value @fhirvs:all-types}; # The type of the required data fhir:DataRequirement.profile @<canonical>*; # The profile of the required data ( # E.g. Patient, Practitioner, # RelatedPerson, Organization, # Location, Device fhir:DataRequirement.subjectCodeableConcept @<CodeableConcept> | fhir:DataRequirement.subjectReference @<Reference> )?; fhir:DataRequirement.mustSupport @<string>*; # Indicates specific structure # elements that are referenced by # the knowledge module fhir:DataRequirement.codeFilter @<DataRequirement.codeFilter>*; # What codes are expected fhir:DataRequirement.dateFilter @<DataRequirement.dateFilter>*; # What dates/date ranges are expected fhir:DataRequirement.limit @<positiveInt>?; # Number of results fhir:DataRequirement.sort @<DataRequirement.sort>*; # Order of the results fhir:index xsd:integer? # Relative position in a list } # How the medication is/was taken or should be taken <Dosage> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored # even if unrecognized fhir:Dosage.sequence @<integer>?; # The order of the dosage # instructions fhir:Dosage.text @<string>?; # Free text dosage instructions e.g. # SIG fhir:Dosage.additionalInstruction @<CodeableConcept>*; # Supplemental instruction or # warnings to the patient - e.g. # "with meals", "may cause # drowsiness" fhir:Dosage.patientInstruction @<string>?; # Patient or consumer oriented # instructions fhir:Dosage.timing @<Timing>?; # When medication should be # administered ( # Take "as needed" (for x) fhir:Dosage.asNeededBoolean @<boolean> | fhir:Dosage.asNeededCodeableConcept @<CodeableConcept> )?; fhir:Dosage.site @<CodeableConcept>?; # Body site to administer to fhir:Dosage.route @<CodeableConcept>?; # How drug should enter body fhir:Dosage.method @<CodeableConcept>?; # Technique for administering # medication fhir:Dosage.doseAndRate @<Dosage.doseAndRate>*; # Amount of medication administered fhir:Dosage.maxDosePerPeriod @<Ratio>?; # Upper limit on medication per unit # of time fhir:Dosage.maxDosePerAdministration @<SimpleQuantity>?; # Upper limit on medication per # administration fhir:Dosage.maxDosePerLifetime @<SimpleQuantity>?; # Upper limit on medication per # lifetime of the patient fhir:index xsd:integer? # Relative position in a list } # Primitive Type uuid <uuid> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for uuid fhir:index xsd:integer? # Relative position in a list } # A reference to a code defined by a terminology system <Coding> CLOSED { a NONLITERAL?; fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Coding.system @<uri>?; # Identity of the terminology system fhir:Coding.version @<string>?; # Version of the system - if relevant fhir:Coding.code @<code>?; # Symbol in syntax defined by the # system fhir:Coding.display @<string>?; # Representation defined by the # system fhir:Coding.userSelected @<boolean>?; # If this coding was chosen directly # by the user fhir:index xsd:integer? # Relative position in a list } # A series of measurements taken by a device <SampledData> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:SampledData.origin @<SimpleQuantity>; # Zero value and units fhir:SampledData.period @<decimal>; # Number of milliseconds between # samples fhir:SampledData.factor @<decimal>?; # Multiply data by this before # adding to origin fhir:SampledData.lowerLimit @<decimal>?; # Lower limit of detection fhir:SampledData.upperLimit @<decimal>?; # Upper limit of detection fhir:SampledData.dimensions @<positiveInt>; # Number of sample points at each # time point fhir:SampledData.data @<string>?; # Decimal values with spaces, or "E" # | "U" | "L" fhir:index xsd:integer? # Relative position in a list } # Primitive Type id <id> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for id fhir:index xsd:integer? # Relative position in a list } # Primitive Type positiveInt <positiveInt> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for positiveInt fhir:index xsd:integer? # Relative position in a list } # A length - a value with a unit that is a physical distance <Distance> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.comparator @<code> AND {fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to # understand the value fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # Time range defined by start and end date/time <Period> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Period.start @<dateTime>?; # Starting time with inclusive # boundary fhir:Period.end @<dateTime>?; # End time with inclusive boundary, # if not ongoing fhir:index xsd:integer? # Relative position in a list } # Primitive Type canonical <canonical> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for canonical fhir:index xsd:integer? # Relative position in a list } # Related artifacts for a knowledge resource <RelatedArtifact> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:RelatedArtifact.type @<code> AND {fhir:value @fhirvs:related-artifact-type}; # documentation | justification | # citation | predecessor | successor # | derived-from | depends-on | # composed-of fhir:RelatedArtifact.label @<string>?; # Short label fhir:RelatedArtifact.display @<string>?; # Brief description of the related # artifact fhir:RelatedArtifact.citation @<markdown>?; # Bibliographic citation for the # artifact fhir:RelatedArtifact.url @<url>?; # Where the artifact can be accessed fhir:RelatedArtifact.document @<Attachment>?; # What document is being referenced fhir:RelatedArtifact.resource @<canonical>?; # What resource is being referenced fhir:index xsd:integer? # Relative position in a list } # Primitive Type base64Binary <base64Binary> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for base64Binary fhir:index xsd:integer? # Relative position in a list } # Describes the context of use for a conformance or knowledge resource <UsageContext> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:UsageContext.code @<Coding>; # Type of context being specified ( # Value that defines the context fhir:UsageContext.valueCodeableConcept @<CodeableConcept> | fhir:UsageContext.valueQuantity @<Quantity> | fhir:UsageContext.valueRange @<Range> | fhir:UsageContext.valueReference @<Reference> ); fhir:index xsd:integer? # Relative position in a list } # A timing schedule that specifies an event that may occur multiple times <Timing> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored # even if unrecognized fhir:Timing.event @<dateTime>*; # When the event occurs fhir:Timing.repeat @<Timing.repeat>?; # When the event is to occur fhir:Timing.code @<CodeableConcept>?; # BID | TID | QID | AM | PM | QD | # QOD | + fhir:index xsd:integer? # Relative position in a list } # Primitive Type decimal <decimal> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.Decimal>?; # Primitive value for decimal fhir:index xsd:integer? # Relative position in a list } # Definition of a parameter to a module <ParameterDefinition> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:ParameterDefinition.name @<code>?; # Name used to access the parameter # value fhir:ParameterDefinition.use @<code> AND {fhir:value @fhirvs:operation-parameter-use}; # in | out fhir:ParameterDefinition.min @<integer>?; # Minimum cardinality fhir:ParameterDefinition.max @<string>?; # Maximum cardinality (a number of *) fhir:ParameterDefinition.documentation @<string>?; # A brief description of the # parameter fhir:ParameterDefinition.type @<code> AND {fhir:value @fhirvs:all-types}; # What type of value fhir:ParameterDefinition.profile @<canonical>?; # What profile the value is expected # to be fhir:index xsd:integer? # Relative position in a list } # Primitive Type dateTime <dateTime> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.DateTime>?; # Primitive value for dateTime fhir:index xsd:integer? # Relative position in a list } # Contributor information <Contributor> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Contributor.type @<code> AND {fhir:value @fhirvs:contributor-type}; # author | editor | reviewer | # endorser fhir:Contributor.name @<string>; # Who contributed the content fhir:Contributor.contact @<ContactDetail>*; # Contact details of the contributor fhir:index xsd:integer? # Relative position in a list } # Primitive Type oid <oid> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for oid fhir:index xsd:integer? # Relative position in a list } # Primitive Type instant <instant> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.DateTime>?; # Primitive value for instant fhir:index xsd:integer? # Relative position in a list } # Details of a Technology mediated contact point (phone, fax, email, etc.) <ContactPoint> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:ContactPoint.system @<code> AND {fhir:value @fhirvs:contact-point-system}?; # phone | fax | email | pager | url # | sms | other fhir:ContactPoint.value @<string>?; # The actual contact point details fhir:ContactPoint.use @<code> AND {fhir:value @fhirvs:contact-point-use}?; # home | work | temp | old | mobile # - purpose of this contact point fhir:ContactPoint.rank @<positiveInt>?; # Specify preferred order of use (1 # = highest) fhir:ContactPoint.period @<Period>?; # Time period when the contact point # was/is in use fhir:index xsd:integer? # Relative position in a list } # Name of a human - parts and usage <HumanName> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:HumanName.use @<code> AND {fhir:value @fhirvs:name-use}?; # usual | official | temp | nickname # | anonymous | old | maiden fhir:HumanName.text @<string>?; # Text representation of the full # name fhir:HumanName.family @<string>?; # Family name (often called # 'Surname') fhir:HumanName.given @<string>*; # Given names (not always 'first'). # Includes middle names fhir:HumanName.prefix @<string>*; # Parts that come before the name fhir:HumanName.suffix @<string>*; # Parts that come after the name fhir:HumanName.period @<Period>?; # Time period when name was/is in use fhir:index xsd:integer? # Relative position in a list } # An amount of economic utility in some recognized currency <Money> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Money.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Money.currency @<code> AND {fhir:value @fhirvs:currencies}?; # ISO 4217 Currency Code fhir:index xsd:integer? # Relative position in a list } # Primitive Type markdown <markdown> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for markdown fhir:index xsd:integer? # Relative position in a list } # A ratio of two Quantity values - a numerator and a denominator <Ratio> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Ratio.numerator @<Quantity>?; # Numerator value fhir:Ratio.denominator @<Quantity>?; # Denominator value fhir:index xsd:integer? # Relative position in a list } # A duration of time during which an organism (or a process) has existed <Age> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.comparator @<code> AND {fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to # understand the value fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # Defines an expected trigger for a module <TriggerDefinition> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:TriggerDefinition.type @<code> AND {fhir:value @fhirvs:trigger-type}; # named-event | periodic | # data-changed | data-added | # data-modified | data-removed | # data-accessed | data-access-ended fhir:TriggerDefinition.name @<string>?; # Name or URI that identifies the # event ( # Timing of the event fhir:TriggerDefinition.timingTiming @<Timing> | fhir:TriggerDefinition.timingReference @<Reference> | fhir:TriggerDefinition.timingDate @<date> | fhir:TriggerDefinition.timingDateTime @<dateTime> )?; fhir:TriggerDefinition.data @<DataRequirement>*; # Triggering data of the event # (multiple = 'and') fhir:TriggerDefinition.condition @<Expression>?; # Whether the event triggers # (boolean expression) fhir:index xsd:integer? # Relative position in a list } # A measured or measurable amount <Quantity> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.comparator @<code> AND {fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to # understand the value fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # Primitive Type url <url> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for url fhir:index xsd:integer? # Relative position in a list } # Text node with attribution <Annotation> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations ( # Individual responsible for the # annotation fhir:Annotation.authorReference @<Reference> | fhir:Annotation.authorString @<string> )?; fhir:Annotation.time @<dateTime>?; # When the annotation was made fhir:Annotation.text @<markdown>; # The annotation - text content (as # markdown) fhir:index xsd:integer? # Relative position in a list } # Contact information <ContactDetail> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:ContactDetail.name @<string>?; # Name of an individual to contact fhir:ContactDetail.telecom @<ContactPoint>*; # Contact details for individual or # organization fhir:index xsd:integer? # Relative position in a list } # An expression that can be used to generate a value <Expression> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Expression.description @<string>?; # Natural language description of # the condition fhir:Expression.name @<id>?; # Short name assigned to expression # for reuse fhir:Expression.language @<code>; # text/cql | text/fhirpath | # application/x-fhir-query | etc. fhir:Expression.expression @<string>?; # Expression in specified language fhir:Expression.reference @<uri>?; # Where the expression is found fhir:index xsd:integer? # Relative position in a list } # A Signature - XML DigSig, JWS, Graphical image of signature, etc. <Signature> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Signature.type @<Coding>+; # Indication of the reason the # entity signed the object(s) fhir:Signature.when @<instant>; # When the signature was created fhir:Signature.who @<Reference>; # Who signed fhir:Signature.onBehalfOf @<Reference>?; # The party represented fhir:Signature.targetFormat @<code> AND {fhir:value @fhirvs:mimetypes}?; # The technical format of the signed # resources fhir:Signature.sigFormat @<code> AND {fhir:value @fhirvs:mimetypes}?; # The technical format of the # signature fhir:Signature.data @<base64Binary>?; # The actual signature content (XML # DigSig. JWS, picture, etc.) fhir:index xsd:integer? # Relative position in a list } # Primitive Type unsignedInt <unsignedInt> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.String>?; # Primitive value for unsignedInt fhir:index xsd:integer? # Relative position in a list } # Primitive Type time <time> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # xml:id (or equivalent in JSON) fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:value @<http://hl7.org/fhirpath/System.Time>?; # Primitive value for time fhir:index xsd:integer? # Relative position in a list } # What dates/date ranges are expected <DataRequirement.dateFilter> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:DataRequirement.dateFilter.path @<string>?; # A date-valued attribute to filter # on fhir:DataRequirement.dateFilter.searchParam @<string>?; # A date valued parameter to search # on ( # The value of the filter, as a # Period, DateTime, or Duration # value fhir:DataRequirement.dateFilter.valueDateTime @<dateTime> | fhir:DataRequirement.dateFilter.valuePeriod @<Period> | fhir:DataRequirement.dateFilter.valueDuration @<Duration> )?; fhir:index xsd:integer? # Relative position in a list } # When the event is to occur <Timing.repeat> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations ( # Length/Range of lengths, or (Start # and/or end) limits fhir:Timing.repeat.boundsDuration @<Duration> | fhir:Timing.repeat.boundsRange @<Range> | fhir:Timing.repeat.boundsPeriod @<Period> )?; fhir:Timing.repeat.count @<positiveInt>?; # Number of times to repeat fhir:Timing.repeat.countMax @<positiveInt>?; # Maximum number of times to repeat fhir:Timing.repeat.duration @<decimal>?; # How long when it happens fhir:Timing.repeat.durationMax @<decimal>?; # How long when it happens (Max) fhir:Timing.repeat.durationUnit @<code> AND {fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a - # unit of time (UCUM) fhir:Timing.repeat.frequency @<positiveInt>?; # Event occurs frequency times per # period fhir:Timing.repeat.frequencyMax @<positiveInt>?; # Event occurs up to frequencyMax # times per period fhir:Timing.repeat.period @<decimal>?; # Event occurs frequency times per # period fhir:Timing.repeat.periodMax @<decimal>?; # Upper limit of period (3-4 hours) fhir:Timing.repeat.periodUnit @<code> AND {fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a - # unit of time (UCUM) fhir:Timing.repeat.dayOfWeek @<code> AND {fhir:value @fhirvs:days-of-week}*; # mon | tue | wed | thu | fri | sat # | sun fhir:Timing.repeat.timeOfDay @<time>*; # Time of day for action fhir:Timing.repeat.when @<code> AND {fhir:value @fhirvs:event-timing}*; # Code for time period of occurrence fhir:Timing.repeat.offset @<unsignedInt>?; # Minutes from event (before or # after) fhir:index xsd:integer? # Relative position in a list } # Order of the results <DataRequirement.sort> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:DataRequirement.sort.path @<string>; # The name of the attribute to # perform the sort fhir:DataRequirement.sort.direction @<code> AND {fhir:value @fhirvs:sort-direction}; # ascending | descending fhir:index xsd:integer? # Relative position in a list } # What codes are expected <DataRequirement.codeFilter> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:DataRequirement.codeFilter.path @<string>?; # A code-valued attribute to filter # on fhir:DataRequirement.codeFilter.searchParam @<string>?; # A coded (token) parameter to # search on fhir:DataRequirement.codeFilter.valueSet @<canonical>?; # Valueset for the filter fhir:DataRequirement.codeFilter.code @<Coding>*; # What code is expected fhir:index xsd:integer? # Relative position in a list } # Amount of medication administered <Dosage.doseAndRate> CLOSED { fhir:Element.id @<http://hl7.org/fhirpath/System.String>?; # Unique id for inter-element # referencing fhir:Element.extension @<Extension>*; # Additional content defined by # implementations fhir:Dosage.doseAndRate.type @<CodeableConcept>?; # The kind of dose or rate specified ( # Amount of medication per dose fhir:Dosage.doseAndRate.doseRange @<Range> | fhir:Dosage.doseAndRate.doseQuantity @<SimpleQuantity> )?; ( # Amount of medication per unit of # time fhir:Dosage.doseAndRate.rateRatio @<Ratio> | fhir:Dosage.doseAndRate.rateRange @<Range> | fhir:Dosage.doseAndRate.rateQuantity @<SimpleQuantity> )?; fhir:index xsd:integer? # Relative position in a list } #---------------------- Reference Types ------------------- #---------------------- Value Sets ------------------------ # Telecommunications form for contact point. fhirvs:contact-point-system ["phone" "fax" "email" "pager" "url" "sms" "other"] # This value set includes all possible codes from BCP-13 (http://tools.ietf.org/html/bcp13) fhirvs:mimetypes EXTERNAL # The use of an address. fhirvs:address-use ["home" "work" "temp" "old" "billing"] # Degree of preference of a type of conditioned specimen. fhirvs:specimen-contained-preference ["preferred" "alternate"] # The status of a resource narrative. fhirvs:narrative-status ["generated" "extensions" "additional" "empty"] # Whether an operation parameter is an input or an output parameter. fhirvs:operation-parameter-use ["in" "out"] # The possible sort directions, ascending or descending. fhirvs:sort-direction ["ascending" "descending"] # Currency codes from ISO 4217 (see https://www.iso.org/iso-4217-currency-codes.html) fhirvs:currencies ["AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TVD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"] # The type of relationship to the related artifact. fhirvs:related-artifact-type ["documentation" "justification" "citation" "predecessor" "successor" "derived-from" "depends-on" "composed-of"] # The type of contributor. fhirvs:contributor-type ["author" "editor" "reviewer" "endorser"] # The days of the week. fhirvs:days-of-week ["mon" "tue" "wed" "thu" "fri" "sat" "sun"] # The type of trigger. fhirvs:trigger-type ["named-event" "periodic" "data-changed" "data-added" "data-modified" "data-removed" "data-accessed" "data-access-ended"] # The type of an address (physical / postal). fhirvs:address-type ["postal" "physical" "both"] # Identifies the purpose for this identifier, if known . fhirvs:identifier-use ["usual" "official" "temp" "secondary" "old"] # Use of contact point. fhirvs:contact-point-use ["home" "work" "temp" "old" "mobile"]
Name Flags Card. Type Description & Constraints doco
.. Observation C icon 1..1 Observation Triglyceride Result
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages ( required ): IETF language tag for a human language

... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... instantiates[x] Σ 0..1 canonical ( ObservationDefinition ), Reference ( ObservationDefinition ) Instantiates FHIR ObservationDefinition
... basedOn Σ 0..* Reference ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) Fulfills plan, proposal or order
... triggeredBy 0..* BackboneElement Triggering observation(s)
.... 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
.... observation Σ 1..1 Reference ( Observation ) Triggering observation
.... type Σ 1..1 code reflex | repeat | re-run
Binding: triggered Bytype ( required ): The type of TriggeredBy Observation.

.... reason 0..1 string Reason that the observation was triggered
... partOf Σ 0..* Reference ( MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy ) Part of referenced event
... status ?! Σ 1..1 code registered | preliminary | final | amended +
Binding: Observation Status ( required ): Codes providing the status of an observation.

... category 0..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes ( preferred ): Codes for high level observation categories.


... code S Σ C icon 1..1 CodeableConcept Triglyceride
Binding: LOINC Codes ( example ): Codes identifying names of simple observations.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 35217-9
..... display 1..1 string Representation defined by the system
Fixed Value: Triglyceride [Moles/​volume] in Serum or Plasma
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference ( Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct ) Who and/or what the observation is about
... focus Σ TU 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
... Slices for value[x] Σ C icon 0 .. 1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueMarkdown markdown
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... valueAttachment Attachment
.... valueReference Reference ( MolecularSequence )
.... valueCanonical canonical (Any)
.... value[x]:valueQuantity S Σ C icon 0..1 Quantity Triglyceride value
... dataAbsentReason C icon 0..1 CodeableConcept Why the result is missing
Binding: Data Absent Reason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing.

... interpretation S 0..1 CodeableConcept + | ++ | +++ | - | -- | ---
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations.


... note S 0..* Annotation Comments about result
... bodySite C icon 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures ( example ): SNOMED CT Body site concepts

... bodyStructure C icon 0..1 Reference ( BodyStructure ) Observed body structure
... method 0..1 CodeableConcept How it was done
Binding: Observation Methods ( example ): Methods for simple observations.

... specimen C icon 0..1 Reference ( Specimen | Group ) Specimen used for this observation
... device 0..1 Reference ( Device | DeviceMetric ) (Measurement) Device
... referenceRange S C icon 1..1 BackboneElement Provides guide for interpretation
.... 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
.... high C icon 1..1 SimpleQuantity High Range, if relevant
.... normalValue 0..1 CodeableConcept Normal value, if relevant
Binding: Observation Reference Range Normal Value Codes ( extensible ): Codes identifying the normal value of the observation.

.... text C icon 0..1 markdown Text based reference range in an observation
... component Σ C icon 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 Σ C icon 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes ( example ): Codes identifying names of simple observations.

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueMarkdown markdown
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... valueAttachment Attachment
..... valueReference Reference ( MolecularSequence )
..... valueCanonical canonical (Any)
.... dataAbsentReason 0..1 CodeableConcept Why the component result is missing
Binding: Data Absent Reason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing.

.... interpretation 0..* CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations.


.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format icon

<!-- ExampleLipidProfile -->doco


# The use of a human name.
fhirvs:name-use ["usual" "official" "temp" "nickname" "anonymous" "old" "maiden"]

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <# Real world event relating to the schedule.
fhirvs:event-timing ["MORN" "MORN.early" "MORN.late" "NOON" "AFT" "AFT.early" "AFT.late" "EVE" "EVE.early" "EVE.late" "NIGHT" "PHS" "HS" "WAKE" "C" "CM" "CD" "CV" "AC" "ACM" "ACD" "ACV" "PC" "PCM" "PCD" "PCV"]

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Business Identifier for observation --></identifier>
 <instantiates[x]><!-- I 0..1 canonical|Reference(ObservationDefinition) 
     Instantiates FHIR ObservationDefinition --></instantiates[x]>
 <basedOn><!-- I 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <triggeredBy> I 0..* BackboneElement  <!-- I 0..* Triggering observation(s) -->
  <# How the Quantity should be understood and represented.
fhirvs:quantity-comparator ["<" "<=" ">=" ">"]

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <observation><!-- I 1..1 Reference(Observation) 
      Triggering observation --></observation>
  <type value="[code]"/><!-- I 1..1 reflex | repeat | re-run   -->
  <reason value="[string]"/><!-- I 0..1 Reason that the observation was triggered -->
 </triggeredBy>
 <partOf><!-- I 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- I 1..1 registered | preliminary | final | amended +   -->
 <category><!-- I 0..* CodeableConcept Classification of  type of observation   --></category>
 <code><!-- I 1..1 CodeableConcept Triglyceride   --></code>
 <subject><!-- I 0..1 Reference(Patient) 
     Who and/or what the observation is about --></subject>
 <focus><!-- I 0..* Reference(Resource) 
     What the observation is about, when it is not about the subject of record --></focus>
 <encounter><!-- I 0..1 Reference(Encounter) 
     Healthcare event during which this observation is made --></encounter>
 <effective[x]><!-- I 0..1 dateTime|Period|Timing|instant 
     Clinically relevant time/time-period for observation --></effective[x]>
 <issued value="[instant]"/><!-- I 0..1 Date/Time this version was made available -->
 <performer><!-- I 0..* Reference(Practitioner) 
     Who is responsible for the observation --></performer>
 <-- value[x] sliced by type:$this  in the specified orderOpen-->

 <valueQuantity><!-- I 0..1 Quantity Triglyceride value --></valueQuantity>
 <dataAbsentReason><!-- I 0..1 CodeableConcept Why the result is missing   --></dataAbsentReason>
 <interpretation><!-- I 0..1 CodeableConcept + | ++ | +++ | - | -- | ---   --></interpretation>
 <note><!-- I 0..* Annotation Comments about result --></note>
 <bodySite><!-- I 0..1 CodeableConcept Observed body part   --></bodySite>
 <bodyStructure><!-- I 0..1 Reference(BodyStructure) Observed body structure --></bodyStructure>
 <method><!-- I 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- I 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- I 0..1 Reference(Device) (Measurement) Device --></device>
 <referenceRange> I 1..1 BackboneElement  <!-- I 1..1 Provides guide for interpretation -->
  <# A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
fhirvs:all-types ["Address" "Age" "Annotation" "Attachment" "BackboneElement" "CodeableConcept" "Coding" "ContactDetail" "ContactPoint" "Contributor" "Count" "DataRequirement" "Distance" "Dosage" "Duration" "Element" "ElementDefinition" "Expression" "Extension" "HumanName" "Identifier" "MarketingStatus" "Meta" "Money" "MoneyQuantity" "Narrative" "ParameterDefinition" "Period" "Population" "ProdCharacteristic" "ProductShelfLife" "Quantity" "Range" "Ratio" "Reference" "RelatedArtifact" "SampledData" "Signature" "SimpleQuantity" "SubstanceAmount" "Timing" "TriggerDefinition" "UsageContext" "base64Binary" "boolean" "canonical" "code" "date" "dateTime" "decimal" "id" "instant" "integer" "markdown" "oid" "positiveInt" "string" "time" "unsignedInt" "uri" "url" "uuid" "xhtml" "Account" "ActivityDefinition" "AdverseEvent" "AllergyIntolerance" "Appointment" "AppointmentResponse" "AuditEvent" "Basic" "Binary" "BiologicallyDerivedProduct" "BodyStructure" "Bundle" "CapabilityStatement" "CarePlan" "CareTeam" "CatalogEntry" "ChargeItem" "ChargeItemDefinition" "Claim" "ClaimResponse" "ClinicalImpression" "CodeSystem" "Communication" "CommunicationRequest" "CompartmentDefinition" "Composition" "ConceptMap" "Condition" "Consent" "Contract" "Coverage" "CoverageEligibilityRequest" "CoverageEligibilityResponse" "DetectedIssue" "Device" "DeviceDefinition" "DeviceMetric" "DeviceRequest" "DeviceUseStatement" "DiagnosticReport" "DocumentManifest" "DocumentReference" "DomainResource" "EffectEvidenceSynthesis" "Encounter" "Endpoint" "EnrollmentRequest" "EnrollmentResponse" "EpisodeOfCare" "EventDefinition" "Evidence" "EvidenceVariable" "ExampleScenario" "ExplanationOfBenefit" "FamilyMemberHistory" "Flag" "Goal" "GraphDefinition" "Group" "GuidanceResponse" "HealthcareService" "ImagingStudy" "Immunization" "ImmunizationEvaluation" "ImmunizationRecommendation" "ImplementationGuide" "InsurancePlan" "Invoice" "Library" "Linkage" "List" "Location" "Measure" "MeasureReport" "Media" "Medication" "MedicationAdministration" "MedicationDispense" "MedicationKnowledge" "MedicationRequest" "MedicationStatement" "MedicinalProduct" "MedicinalProductAuthorization" "MedicinalProductContraindication" "MedicinalProductIndication" "MedicinalProductIngredient" "MedicinalProductInteraction" "MedicinalProductManufactured" "MedicinalProductPackaged" "MedicinalProductPharmaceutical" "MedicinalProductUndesirableEffect" "MessageDefinition" "MessageHeader" "MolecularSequence" "NamingSystem" "NutritionOrder" "Observation" "ObservationDefinition" "OperationDefinition" "OperationOutcome" "Organization" "OrganizationAffiliation" "Parameters" "Patient" "PaymentNotice" "PaymentReconciliation" "Person" "PlanDefinition" "Practitioner" "PractitionerRole" "Procedure" "Provenance" "Questionnaire" "QuestionnaireResponse" "RelatedPerson" "RequestGroup" "ResearchDefinition" "ResearchElementDefinition" "ResearchStudy" "ResearchSubject" "Resource" "RiskAssessment" "RiskEvidenceSynthesis" "Schedule" "SearchParameter" "ServiceRequest" "Slot" "Specimen" "SpecimenDefinition" "StructureDefinition" "StructureMap" "Subscription" "Substance" "SubstanceNucleicAcid" "SubstancePolymer" "SubstanceProtein" "SubstanceReferenceInformation" "SubstanceSourceMaterial" "SubstanceSpecification" "SupplyDelivery" "SupplyRequest" "Task" "TerminologyCapabilities" "TestReport" "TestScript" "ValueSet" "VerificationResult" "VisionPrescription" "Type" "Any"]

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <low><!-- I 0..0 Quantity 
      Low Range, if relevant --></low>
  <high><!-- I 1..1 Quantity 
      High Range, if relevant --></high>
  <normalValue><!-- I 0..1 CodeableConcept Normal value, if relevant   --></normalValue>
  <type><!-- I 0..0 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- I 0..0 CodeableConcept Reference range population   --></appliesTo>
  <age><!-- I 0..0 Range 
      Applicable age range, if relevant --></age>
  <text value="[markdown]"/><!-- I 0..1 Text based reference range in an observation -->
 </referenceRange>
 <hasMember><!-- I 0..0 Reference(Observation) 
     Related resource that belongs to the Observation group --></hasMember>
 <derivedFrom><!-- I 0..0 Reference(DocumentReference) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->
  <# A unit of time (units from UCUM).
fhirvs:units-of-time ["s" "min" "h" "d" "wk" "mo" "a"]

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 1..1 CodeableConcept Type of component observation (code / type)   --></code>
  <value[x]><!-- I 0..1 Quantity|CodeableConcept|markdown|
    boolean|integer|Range|Ratio|SampledData|time|dateTime|Period|Attachment|
    Reference(MolecularSequence)|canonical Actual component result --></value[x]>

  <dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result is missing   --></dataAbsentReason>
  <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc   --></interpretation>
  <referenceRange><!-- See http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange  Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>


{ // ExampleLipidProfile
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IBusiness Identifier for observation
  // value[x]: Instantiates FHIR ObservationDefinition. One of these 2:

    "instantiatesCanonical" : "<canonical>", // IInstantiates FHIR ObservationDefinition
    "instantiatesReference" : { Reference(ObservationDefinition) }, // IInstantiates FHIR ObservationDefinition
    "basedOn" : [{ Reference(CarePlan) }], // IFulfills plan, proposal or order
    "triggeredBy" : [{ BackboneElement }], // ITriggering observation(s)
    "partOf" : [{ Reference(MedicationAdministration) }], // IPart of referenced event
    "status" : "<code>", // I R! registered | preliminary | final | amended +
    "category" : [{ CodeableConcept }], // IClassification of  type of observation
    "code" : { CodeableConcept }, // I R! Triglyceride
    "subject" : { Reference(Patient) }, // IWho and/or what the observation is about
    "focus" : [{ Reference(Resource) }], // IWhat the observation is about, when it is not about the subject of record
    "encounter" : { Reference(Encounter) }, // IHealthcare event during which this observation is made
  // value[x]: Clinically relevant time/time-period for observation. One of these 4:

    "effectiveDateTime" : "<dateTime>", // IClinically relevant time/time-period for observation
    "effectivePeriod" : { Period }, // IClinically relevant time/time-period for observation
    "effectiveTiming" : { Timing }, // IClinically relevant time/time-period for observation
    "effectiveInstant" : "<instant>", // IClinically relevant time/time-period for observation
    "issued" : "<instant>", // IDate/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], // IWho is responsible for the observation
    "valueQuantity" : [ //  sliced by type:$this  in the specified order, Open 
      { // Triglyceride value // I
        // from Element: extension
      }
    ],
    "dataAbsentReason" : { CodeableConcept }, // IWhy the result is missing
    "interpretation" : { CodeableConcept }, // I+ | ++ | +++ | - | -- | ---
    "note" : [{ Annotation }], // IComments about result
    "bodySite" : { CodeableConcept }, // IObserved body part
    "bodyStructure" : { Reference(BodyStructure) }, // IObserved body structure
    "method" : { CodeableConcept }, // IHow it was done
    "specimen" : { Reference(Specimen) }, // ISpecimen used for this observation
    "device" : { Reference(Device) }, // I(Measurement) Device
    "referenceRange" : { BackboneElement }, // I R! Provides guide for interpretation
    "component" : [{ BackboneElement }], // IComponent results
  }

Usage note: every effort has been made This structure is derived from Observation .

Summary

Mandatory: 3 elements
Must-Support: 5 elements
Prohibited: 6 elements

Differential View

This indicates the differences between this profile and the base Observation structure.

Name Flags Card. Type Description & Constraints doco
.. Observation 1..1 Observation Triglyceride Result
... code S 1..1 CodeableConcept Triglyceride
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 35217-9
..... display 1..1 string Representation defined by the system
Fixed Value: Triglyceride [Moles/​volume] in Serum or Plasma
... valueQuantity S 0..1 Quantity Triglyceride value
... interpretation S 0..1 CodeableConcept + | ++ | +++ | - | -- | ---
... referenceRange S 1..1 BackboneElement Provides guide for interpretation
.... low 0 .. 0
.... high 1..1 SimpleQuantity High Range, if relevant
.... type 0 .. 0
.... appliesTo 0 .. 0
.... age 0 .. 0
... hasMember 0 .. 0
... derivedFrom 0 .. 0

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to ensure the base Observation structure.

Name Flags Card. Type Description & Constraints doco
.. Observation C icon 1..1 Observation Triglyceride Result
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages ( required ): IETF language tag for a human language

... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... instantiates[x] Σ 0..1 canonical ( ObservationDefinition ), Reference ( ObservationDefinition ) Instantiates FHIR ObservationDefinition
... basedOn Σ 0..* Reference ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) Fulfills plan, proposal or order
... triggeredBy 0..* BackboneElement Triggering observation(s)
.... 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
.... observation Σ 1..1 Reference ( Observation ) Triggering observation
.... type Σ 1..1 code reflex | repeat | re-run
Binding: triggered Bytype ( required ): The type of TriggeredBy Observation.

.... reason 0..1 string Reason that the ShEx files are correct and useful, but they are not observation was triggered
... partOf Σ 0..* Reference ( MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy ) Part of referenced event
... status ?! Σ 1..1 code registered | preliminary | final | amended +
Binding: Observation Status ( required ): Codes providing the status of an observation.

... category 0..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes ( preferred ): Codes for high level observation categories.


... code S Σ C icon 1..1 CodeableConcept Triglyceride
Binding: LOINC Codes ( example ): Codes identifying names of simple observations.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a normative terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 35217-9
..... display 1..1 string Representation defined by the system
Fixed Value: Triglyceride [Moles/​volume] in Serum or Plasma
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference ( Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct ) Who and/or what the observation is about
... focus Σ TU 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
... Slices for value[x] Σ C icon 0 .. 1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueMarkdown markdown
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... valueAttachment Attachment
.... valueReference Reference ( MolecularSequence )
.... valueCanonical canonical (Any)
.... value[x]:valueQuantity S Σ C icon 0..1 Quantity Triglyceride value
... dataAbsentReason C icon 0..1 CodeableConcept Why the result is missing
Binding: Data Absent Reason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing.

... interpretation S 0..1 CodeableConcept + | ++ | +++ | - | -- | ---
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations.


... note S 0..* Annotation Comments about result
... bodySite C icon 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures ( example ): SNOMED CT Body site concepts

... bodyStructure C icon 0..1 Reference ( BodyStructure ) Observed body structure
... method 0..1 CodeableConcept How it was done
Binding: Observation Methods ( example ): Methods for simple observations.

... specimen C icon 0..1 Reference ( Specimen | Group ) Specimen used for this observation
... device 0..1 Reference ( Device | DeviceMetric ) (Measurement) Device
... referenceRange S C icon 1..1 BackboneElement Provides guide for interpretation
.... 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
.... high C icon 1..1 SimpleQuantity High Range, if relevant
.... normalValue 0..1 CodeableConcept Normal value, if relevant
Binding: Observation Reference Range Normal Value Codes ( extensible ): Codes identifying the normal value of the specification. observation.

.... text C icon 0..1 markdown Text based reference range in an observation
... component Σ C icon 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 Σ C icon 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes ( example ): Codes identifying names of simple observations.

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueMarkdown markdown
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... valueAttachment Attachment
..... valueReference Reference ( MolecularSequence )
..... valueCanonical canonical (Any)
.... dataAbsentReason 0..1 CodeableConcept Why the component result is missing
Binding: Data Absent Reason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing.

.... interpretation 0..* CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations.


.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format icon

XML Template 

<!-- ExampleLipidProfile -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Business Identifier for observation --></identifier>
 <instantiates[x]><!-- I 0..1 canonical|Reference(ObservationDefinition) 
     Instantiates FHIR ObservationDefinition --></instantiates[x]>
 <basedOn><!-- I 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <triggeredBy> I 0..* BackboneElement  <!-- I 0..* Triggering observation(s) -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <observation><!-- I 1..1 Reference(Observation) 
      Triggering observation --></observation>
  <type value="[code]"/><!-- I 1..1 reflex | repeat | re-run   -->
  <reason value="[string]"/><!-- I 0..1 Reason that the observation was triggered -->
 </triggeredBy>
 <partOf><!-- I 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- I 1..1 registered | preliminary | final | amended +   -->
 <category><!-- I 0..* CodeableConcept Classification of  type of observation   --></category>
 <code><!-- I 1..1 CodeableConcept Triglyceride   --></code>
 <subject><!-- I 0..1 Reference(Patient) 
     Who and/or what the observation is about --></subject>
 <focus><!-- I 0..* Reference(Resource) 
     What the observation is about, when it is not about the subject of record --></focus>
 <encounter><!-- I 0..1 Reference(Encounter) 
     Healthcare event during which this observation is made --></encounter>
 <effective[x]><!-- I 0..1 dateTime|Period|Timing|instant 
     Clinically relevant time/time-period for observation --></effective[x]>
 <issued value="[instant]"/><!-- I 0..1 Date/Time this version was made available -->
 <performer><!-- I 0..* Reference(Practitioner) 
     Who is responsible for the observation --></performer>
 <-- value[x] sliced by type:$this  in the specified orderOpen-->

 <valueQuantity><!-- I 0..1 Quantity Triglyceride value --></valueQuantity>
 <dataAbsentReason><!-- I 0..1 CodeableConcept Why the result is missing   --></dataAbsentReason>
 <interpretation><!-- I 0..1 CodeableConcept + | ++ | +++ | - | -- | ---   --></interpretation>
 <note><!-- I 0..* Annotation Comments about result --></note>
 <bodySite><!-- I 0..1 CodeableConcept Observed body part   --></bodySite>
 <bodyStructure><!-- I 0..1 Reference(BodyStructure) Observed body structure --></bodyStructure>
 <method><!-- I 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- I 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- I 0..1 Reference(Device) (Measurement) Device --></device>
 <referenceRange> I 1..1 BackboneElement  <!-- I 1..1 Provides guide for interpretation -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <low><!-- I 0..0 Quantity 
      Low Range, if relevant --></low>
  <high><!-- I 1..1 Quantity 
      High Range, if relevant --></high>
  <normalValue><!-- I 0..1 CodeableConcept Normal value, if relevant   --></normalValue>
  <type><!-- I 0..0 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- I 0..0 CodeableConcept Reference range population   --></appliesTo>
  <age><!-- I 0..0 Range 
      Applicable age range, if relevant --></age>
  <text value="[markdown]"/><!-- I 0..1 Text based reference range in an observation -->
 </referenceRange>
 <hasMember><!-- I 0..0 Reference(Observation) 
     Related resource that belongs to the Observation group --></hasMember>
 <derivedFrom><!-- I 0..0 Reference(DocumentReference) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 1..1 CodeableConcept Type of component observation (code / type)   --></code>
  <value[x]><!-- I 0..1 Quantity|CodeableConcept|markdown|
    boolean|integer|Range|Ratio|SampledData|time|dateTime|Period|Attachment|
    Reference(MolecularSequence)|canonical Actual component result --></value[x]>

  <dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result is missing   --></dataAbsentReason>
  <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc   --></interpretation>
  <referenceRange><!-- See http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange  Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>

JSON Template 


{ // ExampleLipidProfile
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IBusiness Identifier for observation
  // value[x]: Instantiates FHIR ObservationDefinition. One of these 2:

    "instantiatesCanonical" : "<canonical>", // IInstantiates FHIR ObservationDefinition
    "instantiatesReference" : { Reference(ObservationDefinition) }, // IInstantiates FHIR ObservationDefinition
    "basedOn" : [{ Reference(CarePlan) }], // IFulfills plan, proposal or order
    "triggeredBy" : [{ BackboneElement }], // ITriggering observation(s)
    "partOf" : [{ Reference(MedicationAdministration) }], // IPart of referenced event
    "status" : "<code>", // I R! registered | preliminary | final | amended +
    "category" : [{ CodeableConcept }], // IClassification of  type of observation
    "code" : { CodeableConcept }, // I R! Triglyceride
    "subject" : { Reference(Patient) }, // IWho and/or what the observation is about
    "focus" : [{ Reference(Resource) }], // IWhat the observation is about, when it is not about the subject of record
    "encounter" : { Reference(Encounter) }, // IHealthcare event during which this observation is made
  // value[x]: Clinically relevant time/time-period for observation. One of these 4:

    "effectiveDateTime" : "<dateTime>", // IClinically relevant time/time-period for observation
    "effectivePeriod" : { Period }, // IClinically relevant time/time-period for observation
    "effectiveTiming" : { Timing }, // IClinically relevant time/time-period for observation
    "effectiveInstant" : "<instant>", // IClinically relevant time/time-period for observation
    "issued" : "<instant>", // IDate/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], // IWho is responsible for the observation
    "valueQuantity" : [ //  sliced by type:$this  in the specified order, Open 
      { // Triglyceride value // I
        // from Element: extension
      }
    ],
    "dataAbsentReason" : { CodeableConcept }, // IWhy the result is missing
    "interpretation" : { CodeableConcept }, // I+ | ++ | +++ | - | -- | ---
    "note" : [{ Annotation }], // IComments about result
    "bodySite" : { CodeableConcept }, // IObserved body part
    "bodyStructure" : { Reference(BodyStructure) }, // IObserved body structure
    "method" : { CodeableConcept }, // IHow it was done
    "specimen" : { Reference(Specimen) }, // ISpecimen used for this observation
    "device" : { Reference(Device) }, // I(Measurement) Device
    "referenceRange" : { BackboneElement }, // I R! Provides guide for interpretation
    "component" : [{ BackboneElement }], // IComponent results
  }

 

Alternate definitions: Master Definition ( XML , JSON ), Schematron

10.3.13.14.2 Terminology Bindings

Path Name Conformance ValueSet
Observation.language All Languages required All Languages
Observation.triggeredBy.type triggered Bytype required triggered Bytype
Observation.status Observation Status required Observation Status
Observation.category Observation Category Codes preferred Observation Category Codes
Observation.code LOINC Codes example LOINC Codes
Observation.dataAbsentReason Data Absent Reason extensible Data Absent Reason
Observation.interpretation Observation Interpretation Codes extensible Observation Interpretation Codes
Observation.bodySite SNOMED CT Body Structures example SNOMED CT Body Structures
Observation.method Observation Methods example Observation Methods
Observation.referenceRange.normalValue Observation Reference Range Normal Value Codes extensible Observation Reference Range Normal Value Codes
Observation.component.code LOINC Codes example LOINC Codes
Observation.component.dataAbsentReason Data Absent Reason extensible Data Absent Reason
Observation.component.interpretation Observation Interpretation Codes extensible Observation Interpretation Codes
. .