FHIR Implementation Guide for NJSAMS

NJSAMS - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Resource Profile: NJSAMSBasePatient

NJSAMS Patient (Considered legacy, due to some data not having been available at time of creation)

Usage:

• Derived from this Resource Profile: NJSAMSPatient
• CapabilityStatements using this Resource Profile: NJSAMSCapabilities

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile	Information about an individual or animal receiving health care 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 njsams-client-id-system-required: At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id njsams-ssn-required: At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn njsams-drivers-license-optional: An optional New Jersey drivers license
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
language	S	0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:other	S	0..1	string	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherLanguage ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		2..*	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:race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthsex	N	0..1	code	Optional Extensions Element URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:us-citizenship	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/USCitizenship ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:income-eligibility-screening	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IncomeEligibilityScreening ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:gender-identity	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/GenderIdentity Binding: Additional NJSAMS Gender (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
Slices for identifier	SΣ	2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:ssn	SΣ	1..1	Identifier	SSN ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:njsams	SΣ	1..1	Identifier	NJSAMS client Id ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:license	SΣ	0..1	Identifier	NJ State drivers license ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:2.16.840.1.113883.4.3.34
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SΣC	1..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
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
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	1..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	ΣC	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided.
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:municipality	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/DistrictMunicipality Binding: NJSAMS Municipalities (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) ele-1: All FHIR elements must have a @value or children Example General: Madison
state	SΣ	1..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
period	SΣC	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. ele-1: All FHIR elements must have a @value or children
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:ssn.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:njsams.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:license.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Patient.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	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()
njsams-client-id-system-required	error	Patient	At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id : identifier.where(system = 'https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id').exists()
njsams-drivers-license-optional	error	Patient	An optional New Jersey drivers license : identifier.count() = 2 or ( identifier.count() > 2 and identifier.where(system = 'urn:oid:2.16.840.1.113883.4.3.34').exists() )
njsams-ssn-required	error	Patient	At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn : identifier.where(system = 'http://hl7.org/fhir/sid/us-ssn').exists()
per-1	error	Patient.address.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Patient.link.other	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'))
us-core-8	error	Patient.name	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile	Information about an individual or animal receiving health care services njsams-client-id-system-required: At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id njsams-ssn-required: At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn njsams-drivers-license-optional: An optional New Jersey drivers license
language	S	0..1	code	Language of the resource content
Slices for extension				Content/Rules for all slices
extension:other	S	0..1	string	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherLanguage
extension		2..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:race	S	0..1	USCoreRaceExtension	US Core Race Extension
extension:ethnicity	S	0..1	USCoreEthnicityExtension	US Core ethnicity Extension
extension:us-citizenship	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/USCitizenship
extension:income-eligibility-screening	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IncomeEligibilityScreening
extension:gender-identity	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/GenderIdentity Binding: Additional NJSAMS Gender (required)
Slices for identifier		2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:ssn	S	1..1	Identifier	SSN
system		1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
identifier:njsams	S	1..1	Identifier	NJSAMS client Id
system		1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id
identifier:license	S	0..1	Identifier	NJ State drivers license
system		1..1	uri	The namespace for the identifier value Required Pattern: urn:oid:2.16.840.1.113883.4.3.34
name
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
birthDate		1..1	date	The date of birth for the individual
address		1..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:municipality	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/DistrictMunicipality Binding: NJSAMS Municipalities (required)
district	S	0..1	string	District name (aka county)
state		1..1	string	Sub-unit of country (abbreviations ok)
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
njsams-client-id-system-required	error	Patient	At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id : identifier.where(system = 'https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id').exists()
njsams-drivers-license-optional	error	Patient	An optional New Jersey drivers license : identifier.count() = 2 or ( identifier.count() > 2 and identifier.where(system = 'urn:oid:2.16.840.1.113883.4.3.34').exists() )
njsams-ssn-required	error	Patient	At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn : identifier.where(system = 'http://hl7.org/fhir/sid/us-ssn').exists()

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile	Information about an individual or animal receiving health care services njsams-client-id-system-required: At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id njsams-ssn-required: At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn njsams-drivers-license-optional: An optional New Jersey drivers license
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	S	0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:other	S	0..1	string	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherLanguage
value		0..1	code	Primitive value for code Max Length:1048576
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:birthsex	N	0..1	code	Optional Extensions Element URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
extension:us-citizenship	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/USCitizenship
extension:income-eligibility-screening	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IncomeEligibilityScreening
extension:gender-identity	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/GenderIdentity Binding: Additional NJSAMS Gender (required)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:ssn	SΣ	1..1	Identifier	SSN
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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:njsams	SΣ	1..1	Identifier	NJSAMS client Id
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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:license	SΣ	0..1	Identifier	NJ State drivers license
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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: urn:oid:2.16.840.1.113883.4.3.34
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
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	Σ	0..1	string	Text representation of the full name
family	SΣC	1..1	string	Family name (often called 'Surname')
given	SΣC	1..*	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 individual cpt-2: A system is required if a value is provided.
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
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:municipality	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/DistrictMunicipality Binding: NJSAMS Municipalities (required)
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	1..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	SΣC	0..1	Period	Time period when address was/is in use per-1: If present, start SHALL have a lower value than end Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo	C	0..*	Attachment	Image of the patient att-1: If the Attachment has data, it SHALL have a contentType
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
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
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom	C	0..*	ContactPoint	A contact detail for the person cpt-2: A system is required if a value is provided.
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact ref-1: SHALL have a contained resource if a local reference is provided
period	C	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	C	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided
managingOrganization	ΣC	0..1	Reference(Organization)	Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
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
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:ssn.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:ssn.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:njsams.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:njsams.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:license.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:license.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Patient.photo	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
cpt-2	error	Patient.telecom, Patient.contact.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	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()
njsams-client-id-system-required	error	Patient	At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id : identifier.where(system = 'https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id').exists()
njsams-drivers-license-optional	error	Patient	An optional New Jersey drivers license : identifier.count() = 2 or ( identifier.count() > 2 and identifier.where(system = 'urn:oid:2.16.840.1.113883.4.3.34').exists() )
njsams-ssn-required	error	Patient	At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn : identifier.where(system = 'http://hl7.org/fhir/sid/us-ssn').exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
per-1	error	Patient.identifier.period, Patient.identifier:ssn.period, Patient.identifier:njsams.period, Patient.identifier:license.period, Patient.name.period, Patient.telecom.period, Patient.address.period, Patient.contact.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Patient.identifier.assigner, Patient.identifier:ssn.assigner, Patient.identifier:njsams.assigner, Patient.identifier:license.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other	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'))
us-core-8	error	Patient.name	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Summary

Mandatory: 9 elements
Must-Support: 13 elements

Extensions

This structure refers to these extensions:

• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherLanguage
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/USCitizenship
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IncomeEligibilityScreening
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/GenderIdentity
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/DistrictMunicipality

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile	Information about an individual or animal receiving health care 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 njsams-client-id-system-required: At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id njsams-ssn-required: At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn njsams-drivers-license-optional: An optional New Jersey drivers license
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
language	S	0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:other	S	0..1	string	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherLanguage ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		2..*	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:race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthsex	N	0..1	code	Optional Extensions Element URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:us-citizenship	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/USCitizenship ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:income-eligibility-screening	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IncomeEligibilityScreening ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:gender-identity	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/GenderIdentity Binding: Additional NJSAMS Gender (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
Slices for identifier	SΣ	2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:ssn	SΣ	1..1	Identifier	SSN ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:njsams	SΣ	1..1	Identifier	NJSAMS client Id ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:license	SΣ	0..1	Identifier	NJ State drivers license ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:2.16.840.1.113883.4.3.34
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SΣC	1..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
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
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	1..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	ΣC	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided.
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:municipality	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/DistrictMunicipality Binding: NJSAMS Municipalities (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) ele-1: All FHIR elements must have a @value or children Example General: Madison
state	SΣ	1..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
period	SΣC	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. ele-1: All FHIR elements must have a @value or children
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:ssn.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:njsams.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:license.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Patient.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	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()
njsams-client-id-system-required	error	Patient	At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id : identifier.where(system = 'https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id').exists()
njsams-drivers-license-optional	error	Patient	An optional New Jersey drivers license : identifier.count() = 2 or ( identifier.count() > 2 and identifier.where(system = 'urn:oid:2.16.840.1.113883.4.3.34').exists() )
njsams-ssn-required	error	Patient	At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn : identifier.where(system = 'http://hl7.org/fhir/sid/us-ssn').exists()
per-1	error	Patient.address.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Patient.link.other	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'))
us-core-8	error	Patient.name	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Differential View

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile	Information about an individual or animal receiving health care services njsams-client-id-system-required: At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id njsams-ssn-required: At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn njsams-drivers-license-optional: An optional New Jersey drivers license
language	S	0..1	code	Language of the resource content
Slices for extension				Content/Rules for all slices
extension:other	S	0..1	string	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherLanguage
extension		2..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:race	S	0..1	USCoreRaceExtension	US Core Race Extension
extension:ethnicity	S	0..1	USCoreEthnicityExtension	US Core ethnicity Extension
extension:us-citizenship	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/USCitizenship
extension:income-eligibility-screening	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IncomeEligibilityScreening
extension:gender-identity	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/GenderIdentity Binding: Additional NJSAMS Gender (required)
Slices for identifier		2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:ssn	S	1..1	Identifier	SSN
system		1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
identifier:njsams	S	1..1	Identifier	NJSAMS client Id
system		1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id
identifier:license	S	0..1	Identifier	NJ State drivers license
system		1..1	uri	The namespace for the identifier value Required Pattern: urn:oid:2.16.840.1.113883.4.3.34
name
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
birthDate		1..1	date	The date of birth for the individual
address		1..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:municipality	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/DistrictMunicipality Binding: NJSAMS Municipalities (required)
district	S	0..1	string	District name (aka county)
state		1..1	string	Sub-unit of country (abbreviations ok)
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
njsams-client-id-system-required	error	Patient	At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id : identifier.where(system = 'https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id').exists()
njsams-drivers-license-optional	error	Patient	An optional New Jersey drivers license : identifier.count() = 2 or ( identifier.count() > 2 and identifier.where(system = 'urn:oid:2.16.840.1.113883.4.3.34').exists() )
njsams-ssn-required	error	Patient	At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn : identifier.where(system = 'http://hl7.org/fhir/sid/us-ssn').exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	USCorePatientProfile	Information about an individual or animal receiving health care services njsams-client-id-system-required: At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id njsams-ssn-required: At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn njsams-drivers-license-optional: An optional New Jersey drivers license
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	S	0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:other	S	0..1	string	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherLanguage
value		0..1	code	Primitive value for code Max Length:1048576
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:birthsex	N	0..1	code	Optional Extensions Element URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
extension:us-citizenship	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/USCitizenship
extension:income-eligibility-screening	S	1..1	boolean	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IncomeEligibilityScreening
extension:gender-identity	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/GenderIdentity Binding: Additional NJSAMS Gender (required)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	2..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:ssn	SΣ	1..1	Identifier	SSN
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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:njsams	SΣ	1..1	Identifier	NJSAMS client Id
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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:license	SΣ	0..1	Identifier	NJ State drivers license
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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: urn:oid:2.16.840.1.113883.4.3.34
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
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	Σ	0..1	string	Text representation of the full name
family	SΣC	1..1	string	Family name (often called 'Surname')
given	SΣC	1..*	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 individual cpt-2: A system is required if a value is provided.
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
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:municipality	S	0..1	Coding	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/DistrictMunicipality Binding: NJSAMS Municipalities (required)
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	1..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	SΣC	0..1	Period	Time period when address was/is in use per-1: If present, start SHALL have a lower value than end Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo	C	0..*	Attachment	Image of the patient att-1: If the Attachment has data, it SHALL have a contentType
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
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
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom	C	0..*	ContactPoint	A contact detail for the person cpt-2: A system is required if a value is provided.
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact ref-1: SHALL have a contained resource if a local reference is provided
period	C	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	C	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided
managingOrganization	ΣC	0..1	Reference(Organization)	Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
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
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:ssn.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:ssn.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:njsams.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:njsams.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:license.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:license.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Patient.photo	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
cpt-2	error	Patient.telecom, Patient.contact.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	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()
njsams-client-id-system-required	error	Patient	At least one patient identifier system is https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id : identifier.where(system = 'https://fhir.njsams.rutgers.edu/NJSAMS-fhir/client-id').exists()
njsams-drivers-license-optional	error	Patient	An optional New Jersey drivers license : identifier.count() = 2 or ( identifier.count() > 2 and identifier.where(system = 'urn:oid:2.16.840.1.113883.4.3.34').exists() )
njsams-ssn-required	error	Patient	At least one patient identifier system is http://hl7.org/fhir/sid/us-ssn : identifier.where(system = 'http://hl7.org/fhir/sid/us-ssn').exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
per-1	error	Patient.identifier.period, Patient.identifier:ssn.period, Patient.identifier:njsams.period, Patient.identifier:license.period, Patient.name.period, Patient.telecom.period, Patient.address.period, Patient.contact.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Patient.identifier.assigner, Patient.identifier:ssn.assigner, Patient.identifier:njsams.assigner, Patient.identifier:license.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other	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'))
us-core-8	error	Patient.name	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from USCorePatientProfile

Summary

Mandatory: 9 elements
Must-Support: 13 elements

Extensions

This structure refers to these extensions:

• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherLanguage
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/USCitizenship
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/IncomeEligibilityScreening
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/GenderIdentity
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/DistrictMunicipality

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier