Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG, published by HL7 International / Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/HL7/fhir-registry-protocols-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: CREDS Structure Definition ( Experimental )

StructureDefinition for use with CREDS mapping creating the base mappings for FHIR, CDA and V2

Usage:

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

Formal Views of Profile Content

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

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

This structure is derived from StructureDefinition

Name	Flags	Card.	Type	Description & Constraints
StructureDefinition		0..*	StructureDefinition	Structural Definition
identifier		1..1	Identifier	Additional identifier for the structure definition
date		1..1	dateTime	Date last changed
publisher		1..1	string	Name of the publisher (organization or individual)
contact		1..*	ContactDetail	Contact details for the publisher
kind		1..1	code	primitive-type | complex-type | resource | logical Required Pattern: logical
abstract		1..1	boolean	Whether the structure is abstract Required Pattern: false
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
StructureDefinition	C	0..*	StructureDefinition	Structural Definition
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this structure definition, represented as a URI (globally unique)
identifier	Σ	1..1	Identifier	Additional identifier for the structure definition
name	ΣC	1..1	string	Name for this structure definition (computer friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
date	Σ	1..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	Σ	1..*	ContactDetail	Contact details for the publisher
kind	Σ	1..1	code	primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. Required Pattern: logical
abstract	Σ	1..1	boolean	Whether the structure is abstract Required Pattern: false
type	ΣC	1..1	uri	Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
StructureDefinition.status	required	PublicationStatus
StructureDefinition.kind	required	Pattern: logical
StructureDefinition.type	extensible	FHIRDefinedType

Name	Flags	Card.	Type	Description & Constraints
StructureDefinition	C	0..*	StructureDefinition	Structural Definition
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
url	Σ	1..1	uri	Canonical identifier for this structure definition, represented as a URI (globally unique)
identifier	Σ	1..1	Identifier	Additional identifier for the structure definition
version	Σ	0..1	string	Business version of the structure definition
name	ΣC	1..1	string	Name for this structure definition (computer friendly)
title	Σ	0..1	string	Name for this structure definition (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	1..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	Σ	1..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the structure definition
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for structure definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this structure definition is defined
copyright		0..1	markdown	Use and/or publishing restrictions
keyword	Σ	0..*	Coding	Assist with indexing and finding Binding: DefinitionUseCodes (extensible): Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).
fhirVersion	Σ	0..1	code	FHIR Version this StructureDefinition targets Binding: FHIRVersion (required): All published FHIR Versions.
mapping	C	0..*	BackboneElement	External specification that the content is mapped to
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
identity		1..1	id	Internal id when this mapping is used
uri	C	0..1	uri	Identifies what this mapping refers to
name	C	0..1	string	Names what this mapping refers to
comment		0..1	string	Versions, Issues, Scope limitations etc.
kind	Σ	1..1	code	primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. Required Pattern: logical
abstract	Σ	1..1	boolean	Whether the structure is abstract Required Pattern: false
context	ΣC	0..*	BackboneElement	If an extension, where it can be used in instances
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
type	Σ	1..1	code	fhirpath | element | extension Binding: ExtensionContextType (required): How an extension context is interpreted.
expression	Σ	1..1	string	Where the extension can be used in instances
contextInvariant	ΣC	0..*	string	FHIRPath invariants - when the extension can be used
type	ΣC	1..1	uri	Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types.
baseDefinition	ΣC	0..1	canonical(StructureDefinition)	Definition that this type is constrained/specialized from
derivation	Σ	0..1	code	specialization | constraint - How relates to base definition Binding: TypeDerivationRule (required): How a type relates to its baseDefinition.
snapshot	C	0..1	BackboneElement	Snapshot view of the structure
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
element	C	1..*	ElementDefinition	Definition of elements in the resource (if no StructureDefinition)
differential	C	0..1	BackboneElement	Differential view of the structure
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
element		1..*	ElementDefinition	Definition of elements in the resource (if no StructureDefinition)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
StructureDefinition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
StructureDefinition.status	required	PublicationStatus
StructureDefinition.jurisdiction	extensible	Jurisdiction ValueSet
StructureDefinition.keyword	extensible	DefinitionUseCodes
StructureDefinition.fhirVersion	required	FHIRVersion
StructureDefinition.kind	required	Pattern: logical
StructureDefinition.context.type	required	ExtensionContextType
StructureDefinition.type	extensible	FHIRDefinedType
StructureDefinition.derivation	required	TypeDerivationRule

This structure is derived from StructureDefinition

Summary

Mandatory: 4 elements

Differential View

This structure is derived from StructureDefinition

Name	Flags	Card.	Type	Description & Constraints
StructureDefinition		0..*	StructureDefinition	Structural Definition
identifier		1..1	Identifier	Additional identifier for the structure definition
date		1..1	dateTime	Date last changed
publisher		1..1	string	Name of the publisher (organization or individual)
contact		1..*	ContactDetail	Contact details for the publisher
kind		1..1	code	primitive-type | complex-type | resource | logical Required Pattern: logical
abstract		1..1	boolean	Whether the structure is abstract Required Pattern: false
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
StructureDefinition	C	0..*	StructureDefinition	Structural Definition
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this structure definition, represented as a URI (globally unique)
identifier	Σ	1..1	Identifier	Additional identifier for the structure definition
name	ΣC	1..1	string	Name for this structure definition (computer friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
date	Σ	1..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	Σ	1..*	ContactDetail	Contact details for the publisher
kind	Σ	1..1	code	primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. Required Pattern: logical
abstract	Σ	1..1	boolean	Whether the structure is abstract Required Pattern: false
type	ΣC	1..1	uri	Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
StructureDefinition.status	required	PublicationStatus
StructureDefinition.kind	required	Pattern: logical
StructureDefinition.type	extensible	FHIRDefinedType

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
StructureDefinition	C	0..*	StructureDefinition	Structural Definition
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
url	Σ	1..1	uri	Canonical identifier for this structure definition, represented as a URI (globally unique)
identifier	Σ	1..1	Identifier	Additional identifier for the structure definition
version	Σ	0..1	string	Business version of the structure definition
name	ΣC	1..1	string	Name for this structure definition (computer friendly)
title	Σ	0..1	string	Name for this structure definition (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	1..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	Σ	1..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the structure definition
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for structure definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this structure definition is defined
copyright		0..1	markdown	Use and/or publishing restrictions
keyword	Σ	0..*	Coding	Assist with indexing and finding Binding: DefinitionUseCodes (extensible): Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).
fhirVersion	Σ	0..1	code	FHIR Version this StructureDefinition targets Binding: FHIRVersion (required): All published FHIR Versions.
mapping	C	0..*	BackboneElement	External specification that the content is mapped to
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
identity		1..1	id	Internal id when this mapping is used
uri	C	0..1	uri	Identifies what this mapping refers to
name	C	0..1	string	Names what this mapping refers to
comment		0..1	string	Versions, Issues, Scope limitations etc.
kind	Σ	1..1	code	primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. Required Pattern: logical
abstract	Σ	1..1	boolean	Whether the structure is abstract Required Pattern: false
context	ΣC	0..*	BackboneElement	If an extension, where it can be used in instances
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
type	Σ	1..1	code	fhirpath | element | extension Binding: ExtensionContextType (required): How an extension context is interpreted.
expression	Σ	1..1	string	Where the extension can be used in instances
contextInvariant	ΣC	0..*	string	FHIRPath invariants - when the extension can be used
type	ΣC	1..1	uri	Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types.
baseDefinition	ΣC	0..1	canonical(StructureDefinition)	Definition that this type is constrained/specialized from
derivation	Σ	0..1	code	specialization | constraint - How relates to base definition Binding: TypeDerivationRule (required): How a type relates to its baseDefinition.
snapshot	C	0..1	BackboneElement	Snapshot view of the structure
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
element	C	1..*	ElementDefinition	Definition of elements in the resource (if no StructureDefinition)
differential	C	0..1	BackboneElement	Differential view of the structure
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
element		1..*	ElementDefinition	Definition of elements in the resource (if no StructureDefinition)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
StructureDefinition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
StructureDefinition.status	required	PublicationStatus
StructureDefinition.jurisdiction	extensible	Jurisdiction ValueSet
StructureDefinition.keyword	extensible	DefinitionUseCodes
StructureDefinition.fhirVersion	required	FHIRVersion
StructureDefinition.kind	required	Pattern: logical
StructureDefinition.context.type	required	ExtensionContextType
StructureDefinition.type	extensible	FHIRDefinedType
StructureDefinition.derivation	required	TypeDerivationRule

This structure is derived from StructureDefinition

Summary

Mandatory: 4 elements

Other representations of profile: CSV, Excel, Schematron