StructureDefinition-ck-SampleStructureMap
This profile sets minimum expectations for the Observation resource to record, search and fetch SampleStructureMap of a patient. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the Observation resource when using this profile.
Background & Scope
Observation has consists of measurements and simple assertions made about a patient, device or other subject.
Mandatory Data Elements
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Observations are a central element in healthcare, used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics. Most observations are simple name/value pair assertions with some metadata, but some observations group other observations together logically, or even are multi-component observations.
- a status
- a fixed code for observation
- a patient
- a date representing when the observation status was recorded
- a result value code for observation status
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://www.collabkare.io/r4/StructureDefinition/ck-SampleStructureMap
Published on Tue Feb 23 16:30:00 IST 2021 as a active by CollabKare.
This profile builds on StructureMap
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  StructureMap | 0..* | StructureMap | SampleStructureMap | |
  structure | S | 0..* | BackboneElement | Information about structure |
 mode | 1..1 | code | Information about stucture Fixed Value: source | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| StructureMap | I | 0..* | StructureMap | SampleStructureMap |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| url | ΣI | 1..1 | uri | Canonical identifier for this structure map, represented as a URI (globally unique) |
| identifier | ΣI | 0..* | Identifier | Additional identifier for the structure map |
| version | ΣI | 0..1 | string | Business version of the structure map |
| name | ΣI | 1..1 | string | Name for this structure map (computer friendly) |
| title | ΣI | 0..1 | string | Name for this structure map (human friendly) |
| status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ΣI | 0..1 | boolean | For testing purposes, not real usage |
| date | ΣI | 0..1 | dateTime | Date last changed |
| publisher | ΣI | 0..1 | string | Name of the publisher (organization or individual) |
| contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
| description | I | 0..1 | markdown | Natural language description of the structure map |
| useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for structure map (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| purpose | I | 0..1 | markdown | Why this structure map is defined |
| copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
| structure | SΣI | 0..* | BackboneElement | Information about structure |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| url | ΣI | 1..1 | canonical(StructureDefinition) | Canonical reference to structure definition |
| mode | ΣI | 1..1 | code | Information about stucture Binding: StructureMapModelMode (required) Fixed Value: source |
| alias | ΣI | 0..1 | string | Name for type in this map |
| documentation | I | 0..1 | string | Documentation on use of structure |
| import | ΣI | 0..* | canonical(StructureMap) | Other maps used by this map (canonical URLs) |
| group | ΣI | 1..* | BackboneElement | Named sections for reader convenience |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 1..1 | id | Human-readable label |
| extends | ΣI | 0..1 | id | Another group that this group adds rules to |
| typeMode | ΣI | 1..1 | code | none | types | type-and-types Binding: StructureMapGroupTypeMode (required) |
| documentation | ΣI | 0..1 | string | Additional description/explanation for group |
| input | ΣI | 1..* | BackboneElement | Named instance provided when invoking the map |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 1..1 | id | Name for this instance of data |
| type | ΣI | 0..1 | string | Type for this instance of data |
| mode | ΣI | 1..1 | code | source | target Binding: StructureMapInputMode (required) |
| documentation | I | 0..1 | string | Documentation for this instance of data |
| rule | ΣI | 1..* | BackboneElement | Transform Rule from source to target |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 1..1 | id | Name of the rule for internal references |
| source | ΣI | 1..* | BackboneElement | Source inputs to the mapping |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| context | ΣI | 1..1 | id | Type or variable this rule applies to |
| min | ΣI | 0..1 | integer | Specified minimum cardinality |
| max | ΣI | 0..1 | string | Specified maximum cardinality (number or *) |
| type | ΣI | 0..1 | string | Rule only applies if source has this type |
 defaultValue[x] | ΣI | 0..1 | Default value if no value exists | |
| defaultValueBase64Binary | base64Binary | |||
| defaultValueBoolean | boolean | |||
 defaultValueCanonical | canonical(Any) | |||
| defaultValueCode | code | |||
| defaultValueDate | date | |||
| defaultValueDateTime | dateTime | |||
| defaultValueDecimal | decimal | |||
| defaultValueId | id | |||
| defaultValueInstant | instant | |||
| defaultValueInteger | integer | |||
| defaultValueMarkdown | markdown | |||
| defaultValueOid | oid | |||
| defaultValuePositiveInt | positiveInt | |||
| defaultValueString | string | |||
| defaultValueTime | time | |||
| defaultValueUnsignedInt | unsignedInt | |||
| defaultValueUri | uri | |||
| defaultValueUrl | url | |||
| defaultValueUuid | uuid | |||
| defaultValueAddress | Address | |||
| defaultValueAge | Age | |||
| defaultValueAnnotation | Annotation | |||
| defaultValueAttachment | Attachment | |||
| defaultValueCodeableConcept | CodeableConcept | |||
| defaultValueCoding | Coding | |||
| defaultValueContactPoint | ContactPoint | |||
| defaultValueCount | Count | |||
| defaultValueDistance | Distance | |||
| defaultValueDuration | Duration | |||
| defaultValueHumanName | HumanName | |||
| defaultValueIdentifier | Identifier | |||
| defaultValueMoney | Money | |||
| defaultValuePeriod | Period | |||
| defaultValueQuantity | Quantity | |||
| defaultValueRange | Range | |||
| defaultValueRatio | Ratio | |||
| defaultValueReference | Reference(Any) | |||
| defaultValueSampledData | SampledData | |||
| defaultValueSignature | Signature | |||
| defaultValueTiming | Timing | |||
| defaultValueContactDetail | ContactDetail | |||
| defaultValueContributor | Contributor | |||
| defaultValueDataRequirement | DataRequirement | |||
| defaultValueExpression | Expression | |||
| defaultValueParameterDefinition | ParameterDefinition | |||
| defaultValueRelatedArtifact | RelatedArtifact | |||
| defaultValueTriggerDefinition | TriggerDefinition | |||
| defaultValueUsageContext | UsageContext | |||
| defaultValueDosage | Dosage | |||
| defaultValueMeta | Meta | |||
| element | ΣI | 0..1 | string | Optional field for this source |
| listMode | ΣI | 0..1 | code | first | not_first | last | not_last | only_one Binding: StructureMapSourceListMode (required) |
| variable | ΣI | 0..1 | id | Named context for field, if a field is specified |
| condition | ΣI | 0..1 | string | FHIRPath expression - must be true or the rule does not apply |
| check | ΣI | 0..1 | string | FHIRPath expression - must be true or the mapping engine throws an error instead of completing |
| logMessage | ΣI | 0..1 | string | Message to put in log if source exists (FHIRPath) |
| target | ΣI | 0..* | BackboneElement | Content to create because of this mapping rule smp-1: Can only have an element if you have a context smp-2: Must have a contextType if you have a context |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| context | ΣI | 0..1 | id | Type or variable this rule applies to |
| contextType | ΣI | 0..1 | code | type | variable Binding: StructureMapContextType (required) |
| element | ΣI | 0..1 | string | Field to create in the context |
| variable | ΣI | 0..1 | id | Named context for field, if desired, and a field is specified |
| listMode | ΣI | 0..* | code | first | share | last | collate Binding: StructureMapTargetListMode (required) |
| listRuleId | ΣI | 0..1 | id | Internal rule reference for shared list items |
| transform | ΣI | 0..1 | code | create | copy + Binding: StructureMapTransform (required) |
| parameter | ΣI | 0..* | BackboneElement | Parameters to the transform |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | ΣI | 1..1 | Parameter value - variable or literal | |
| valueId | id | |||
| valueString | string | |||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueDecimal | decimal | |||
| rule | ΣI | 0..* | Unknown reference to #StructureMap.group.rule Rules contained in this rule | |
| dependent | ΣI | 0..* | BackboneElement | Which other rules to apply in the context of this rule |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 1..1 | id | Name of a rule or group to apply |
| variable | ΣI | 1..* | string | Variable to pass to the rule or group |
| documentation | I | 0..1 | string | Documentation for this instance of data |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| StructureMap | 0..* | StructureMap | SampleStructureMap | |
| structure | S | 0..* | BackboneElement | Information about structure |
| mode | 1..1 | code | Information about stucture Fixed Value: source | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| StructureMap | I | 0..* | StructureMap | SampleStructureMap |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| url | ΣI | 1..1 | uri | Canonical identifier for this structure map, represented as a URI (globally unique) |
| identifier | ΣI | 0..* | Identifier | Additional identifier for the structure map |
| version | ΣI | 0..1 | string | Business version of the structure map |
| name | ΣI | 1..1 | string | Name for this structure map (computer friendly) |
| title | ΣI | 0..1 | string | Name for this structure map (human friendly) |
| status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ΣI | 0..1 | boolean | For testing purposes, not real usage |
| date | ΣI | 0..1 | dateTime | Date last changed |
| publisher | ΣI | 0..1 | string | Name of the publisher (organization or individual) |
| contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
| description | I | 0..1 | markdown | Natural language description of the structure map |
| useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for structure map (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| purpose | I | 0..1 | markdown | Why this structure map is defined |
| copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
| structure | SΣI | 0..* | BackboneElement | Information about structure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| url | ΣI | 1..1 | canonical(StructureDefinition) | Canonical reference to structure definition |
| mode | ΣI | 1..1 | code | Information about stucture Binding: StructureMapModelMode (required) Fixed Value: source |
| alias | ΣI | 0..1 | string | Name for type in this map |
| documentation | I | 0..1 | string | Documentation on use of structure |
| import | ΣI | 0..* | canonical(StructureMap) | Other maps used by this map (canonical URLs) |
| group | ΣI | 1..* | BackboneElement | Named sections for reader convenience |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 1..1 | id | Human-readable label |
| extends | ΣI | 0..1 | id | Another group that this group adds rules to |
| typeMode | ΣI | 1..1 | code | none | types | type-and-types Binding: StructureMapGroupTypeMode (required) |
| documentation | ΣI | 0..1 | string | Additional description/explanation for group |
| input | ΣI | 1..* | BackboneElement | Named instance provided when invoking the map |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 1..1 | id | Name for this instance of data |
| type | ΣI | 0..1 | string | Type for this instance of data |
| mode | ΣI | 1..1 | code | source | target Binding: StructureMapInputMode (required) |
| documentation | I | 0..1 | string | Documentation for this instance of data |
| rule | ΣI | 1..* | BackboneElement | Transform Rule from source to target |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 1..1 | id | Name of the rule for internal references |
| source | ΣI | 1..* | BackboneElement | Source inputs to the mapping |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| context | ΣI | 1..1 | id | Type or variable this rule applies to |
| min | ΣI | 0..1 | integer | Specified minimum cardinality |
| max | ΣI | 0..1 | string | Specified maximum cardinality (number or *) |
| type | ΣI | 0..1 | string | Rule only applies if source has this type |
| defaultValue[x] | ΣI | 0..1 | Default value if no value exists | |
| defaultValueBase64Binary | base64Binary | |||
| defaultValueBoolean | boolean | |||
| defaultValueCanonical | canonical(Any) | |||
| defaultValueCode | code | |||
| defaultValueDate | date | |||
| defaultValueDateTime | dateTime | |||
| defaultValueDecimal | decimal | |||
| defaultValueId | id | |||
| defaultValueInstant | instant | |||
| defaultValueInteger | integer | |||
| defaultValueMarkdown | markdown | |||
| defaultValueOid | oid | |||
| defaultValuePositiveInt | positiveInt | |||
| defaultValueString | string | |||
| defaultValueTime | time | |||
| defaultValueUnsignedInt | unsignedInt | |||
| defaultValueUri | uri | |||
| defaultValueUrl | url | |||
| defaultValueUuid | uuid | |||
| defaultValueAddress | Address | |||
| defaultValueAge | Age | |||
| defaultValueAnnotation | Annotation | |||
| defaultValueAttachment | Attachment | |||
| defaultValueCodeableConcept | CodeableConcept | |||
| defaultValueCoding | Coding | |||
| defaultValueContactPoint | ContactPoint | |||
| defaultValueCount | Count | |||
| defaultValueDistance | Distance | |||
| defaultValueDuration | Duration | |||
| defaultValueHumanName | HumanName | |||
| defaultValueIdentifier | Identifier | |||
| defaultValueMoney | Money | |||
| defaultValuePeriod | Period | |||
| defaultValueQuantity | Quantity | |||
| defaultValueRange | Range | |||
| defaultValueRatio | Ratio | |||
| defaultValueReference | Reference(Any) | |||
| defaultValueSampledData | SampledData | |||
| defaultValueSignature | Signature | |||
| defaultValueTiming | Timing | |||
| defaultValueContactDetail | ContactDetail | |||
| defaultValueContributor | Contributor | |||
| defaultValueDataRequirement | DataRequirement | |||
| defaultValueExpression | Expression | |||
| defaultValueParameterDefinition | ParameterDefinition | |||
| defaultValueRelatedArtifact | RelatedArtifact | |||
| defaultValueTriggerDefinition | TriggerDefinition | |||
| defaultValueUsageContext | UsageContext | |||
| defaultValueDosage | Dosage | |||
| defaultValueMeta | Meta | |||
| element | ΣI | 0..1 | string | Optional field for this source |
| listMode | ΣI | 0..1 | code | first | not_first | last | not_last | only_one Binding: StructureMapSourceListMode (required) |
| variable | ΣI | 0..1 | id | Named context for field, if a field is specified |
| condition | ΣI | 0..1 | string | FHIRPath expression - must be true or the rule does not apply |
| check | ΣI | 0..1 | string | FHIRPath expression - must be true or the mapping engine throws an error instead of completing |
| logMessage | ΣI | 0..1 | string | Message to put in log if source exists (FHIRPath) |
| target | ΣI | 0..* | BackboneElement | Content to create because of this mapping rule smp-1: Can only have an element if you have a context smp-2: Must have a contextType if you have a context |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| context | ΣI | 0..1 | id | Type or variable this rule applies to |
| contextType | ΣI | 0..1 | code | type | variable Binding: StructureMapContextType (required) |
| element | ΣI | 0..1 | string | Field to create in the context |
| variable | ΣI | 0..1 | id | Named context for field, if desired, and a field is specified |
| listMode | ΣI | 0..* | code | first | share | last | collate Binding: StructureMapTargetListMode (required) |
| listRuleId | ΣI | 0..1 | id | Internal rule reference for shared list items |
| transform | ΣI | 0..1 | code | create | copy + Binding: StructureMapTransform (required) |
| parameter | ΣI | 0..* | BackboneElement | Parameters to the transform |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | ΣI | 1..1 | Parameter value - variable or literal | |
| valueId | id | |||
| valueString | string | |||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueDecimal | decimal | |||
| rule | ΣI | 0..* | Unknown reference to #StructureMap.group.rule Rules contained in this rule | |
| dependent | ΣI | 0..* | BackboneElement | Which other rules to apply in the context of this rule |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 1..1 | id | Name of a rule or group to apply |
| variable | ΣI | 1..* | string | Variable to pass to the rule or group |
| documentation | I | 0..1 | string | Documentation for this instance of data |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
No Search criteria for this Profile.