FHIR Implementation Guide for NJSAMS

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	Practitioner	A person with a formal responsibility in the provisioning of healthcare or related services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:practitionerType	S	1..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PractitionerType Binding: NJSAMS Practitioner Type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	0..*	HumanName	The name(s) associated with the practitioner ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	SΣ	1..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Practitioner	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Practitioner	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Practitioner	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	Practitioner	A person with a formal responsibility in the provisioning of healthcare or related services
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:practitionerType	S	1..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PractitionerType Binding: NJSAMS Practitioner Type (required)
name
text	S	1..1	string	Text representation of the full name
qualification
code		1..1	CodeableConcept	Coded representation of the qualification Binding: NJSAMS Credentials (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Practitioner.qualification.code	required	NJSAMSCredentials https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-supervisorname-vs from this IG

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	Practitioner	A person with a formal responsibility in the provisioning of healthcare or related services
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:practitionerType	S	1..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PractitionerType Binding: NJSAMS Practitioner Type (required)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	Σ	0..*	Identifier	An identifier for the person as this agent
active	Σ	0..1	boolean	Whether this practitioner's record is in active use
name	Σ	0..*	HumanName	The name(s) associated with the practitioner
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Text representation of the full name
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	ΣC	0..1	Period	Time period when name was/is in use per-1: If present, start SHALL have a lower value than end
telecom	ΣC	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles) cpt-2: A system is required if a value is provided.
address	Σ	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the practitioner was born
photo	C	0..*	Attachment	Image of the person att-1: If the Attachment has data, it SHALL have a contentType
qualification		0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..*	Identifier	An identifier for this qualification for the practitioner
code		1..1	CodeableConcept	Coded representation of the qualification Binding: NJSAMS Credentials (required)
period	C	0..1	Period	Period during which the qualification is valid per-1: If present, start SHALL have a lower value than end
issuer	C	0..1	Reference(Organization)	Organization that regulates and issues the qualification ref-1: SHALL have a contained resource if a local reference is provided
communication		0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.code	required	NJSAMSCredentials https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-supervisorname-vs from this IG
Practitioner.communication	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Practitioner.photo	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
cpt-2	error	Practitioner.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Practitioner	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Practitioner	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Practitioner	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Practitioner.name.period, Practitioner.qualification.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Practitioner.qualification.issuer	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Summary

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

Extensions

This structure refers to these extensions:

• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PractitionerType

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	Practitioner	A person with a formal responsibility in the provisioning of healthcare or related services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:practitionerType	S	1..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PractitionerType Binding: NJSAMS Practitioner Type (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	0..*	HumanName	The name(s) associated with the practitioner ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	SΣ	1..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Practitioner	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Practitioner	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Practitioner	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	Practitioner	A person with a formal responsibility in the provisioning of healthcare or related services
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:practitionerType	S	1..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PractitionerType Binding: NJSAMS Practitioner Type (required)
name
text	S	1..1	string	Text representation of the full name
qualification
code		1..1	CodeableConcept	Coded representation of the qualification Binding: NJSAMS Credentials (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Practitioner.qualification.code	required	NJSAMSCredentials https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-supervisorname-vs from this IG

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	Practitioner	A person with a formal responsibility in the provisioning of healthcare or related services
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:practitionerType	S	1..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PractitionerType Binding: NJSAMS Practitioner Type (required)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	Σ	0..*	Identifier	An identifier for the person as this agent
active	Σ	0..1	boolean	Whether this practitioner's record is in active use
name	Σ	0..*	HumanName	The name(s) associated with the practitioner
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Text representation of the full name
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	ΣC	0..1	Period	Time period when name was/is in use per-1: If present, start SHALL have a lower value than end
telecom	ΣC	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles) cpt-2: A system is required if a value is provided.
address	Σ	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the practitioner was born
photo	C	0..*	Attachment	Image of the person att-1: If the Attachment has data, it SHALL have a contentType
qualification		0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..*	Identifier	An identifier for this qualification for the practitioner
code		1..1	CodeableConcept	Coded representation of the qualification Binding: NJSAMS Credentials (required)
period	C	0..1	Period	Period during which the qualification is valid per-1: If present, start SHALL have a lower value than end
issuer	C	0..1	Reference(Organization)	Organization that regulates and issues the qualification ref-1: SHALL have a contained resource if a local reference is provided
communication		0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.code	required	NJSAMSCredentials https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-supervisorname-vs from this IG
Practitioner.communication	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Practitioner.photo	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
cpt-2	error	Practitioner.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Practitioner	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Practitioner	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Practitioner	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** elements	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Practitioner.name.period, Practitioner.qualification.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Practitioner.qualification.issuer	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Summary

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

Extensions

This structure refers to these extensions:

• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/PractitionerType